SWordy Documentation
An Office add-in which allows data import from Stata into Word
Brought to you by:
lo-magno
SWordy 1.0 - How to install SWordy in Windows
Home | SWordy 1.0 documentation
How to install SWordy in Windows
This installation documentation is for Windows users. It will describe how to install SWordy and use it through the remote web server, which is already functioning online and is freely available for all the users.
The following are the software requirements for using SWordy:
SWordy requires SWire for communicating with Stata, which can be downloaded from here. SWire is a HTTP/HTTPS server which runs inside Stata, working like a bridge between Stata and other external software. It thus allows Stata to be queried for performing particular operations or for data exchange.
SWordy requires SWire to run in HTTPS mode. Before the SWire HTTPS server can be started, all the necessary keys and certificates, which are required by the HTTPS protocol, must be generated. Keys and certificates can be generated by executing the following command in Stata:
swire initsecurity
Next, export the SWire Certification Authority Certificate by executing the following command in Stata (this Certificate will be used later):
swire exportcert
Finally, the SWire HTTPS server can started by executing the following command in Stata:
swire start, https
The SWire Certification Authority Certificate must be trusted by Windows; to do this, follow these instructions
1. Double-click on the Certificate (let us suppose it had been exported as "swire_ca.crt"):
2. Click on "Install Certificate...":
3. Place the Certificate in the "Trusted Root Certification Authorities" store:
4. Open Internet Explorer for testing SWire. Do not use a different browser: a valid test can be performed only by using Internet Explorer because it is the browser which is internally used by Word. If Internet Explorer is open, exit and restart it. Use Internet Explorer to connect to the SWire test page: https://localhost:50000/test. If the test is OK, the following web page will appear:
SWordy is an Office add-in and (as is the case with all Office add-ins) it contains a manifest file and a web application: the former describes the add-in by providing Word with all the necessary information for add-in activation; the latter constitutes the core of the add-in and it can be hosted on a remote web server or locally.
The following instructions are for using SWordy from the remote web server, which is already functioning online and is freely available for all the users.
The SWordy manifest to use is the "swordy-manifest.xml" file and it can be downloaded from here. This file must be loaded by Word but, for security reasons, Word can load it only if the manifest is served in an appropriate way. The way which is suggested here is to put the manifest file in a shared folder in Windows. Follow these instructions for loading the manifest file from a shared folder.
1. Create a folder (for example, with the name "manifest") and put the "swordy-manifest.xml" file into it. Then, right-click on this folder and select "Properties":
2. Click on the "Sharing" tab and then click on the "Advanced Sharing..." button:
3. Check the "Share this folder" checkbox and type "SWordy manifest folder" in the "Share name" text field; then click on the "Permissions" button:
4. Enable all permissions and click on "OK" for closing the current dialog window:
5. Take note of the network path which you can read in the "Properties" dialog window. In the example screenshot that name is "\MYUSERNAME-PC\SWordy manifest folder", but it may be different in other PCs:
6. Start Word. If Word is already running, then turn off it and restart it. Click on the "File" tab:
7. Click on "Options":
8. Click on "Trust Center":
9. Click on "Trust Center Settings...":
10. Click on "Trusted Add-in Catalogs":
11. Type the network path to the shared folder (for example, "\MYUSERNAME-PC\SWordy manifest folder") into the "Catalog Url" text field. See step 5 if you do not remember this network path. Then, click on the "Add catalog" button to add this path to the list of the trusted catalog addresses:
12. Find the network path just added in the list of trusted catalog addresses, and check the related "Show in Menu" checkbox. Close all the Word dialog windows, which were opened to set the options by clicking on the "OK" button, and accept all changes:
13. Click on the "Insert" tab on the Word ribbon, click on the "Add-ins" button and choose "My Add-ins": this will open the dialog window to add the SWordy add-in:
14. Click on "Shared folder". Then select "SWordy" and click on "Add":
15. If SWordy has been correctly loaded, a pop-up message will be shown and the "SWordy" tab will appear on the ribbon:
16. Now the user can click on the SWordy tab and start using SWordy:
