I love Java. But there are times that writing a program is more work than it’s worth. And to the novice, trying to get set up with a JVM, IDE, etc only adds to the time commitment.
So I re-introduce you to cURL (I’ve mentioned it a few times on the blog). What is cURL? It’s like a browser – only without the user interface. cURL gets and sends the raw text data to and from a server. This is what you see when you use the “View Source” option in your web browser.
I’ll use cURL to populate a bunch of Connections Cloud communities quickly. (You could do this for on-premises as well.) For example, let’s say my company just moved to Connections Cloud. And for every network shared folder we previously used to be organized (terrible), we’d rather use a Connections Cloud community (awesome). The reason to leverage cURL to do this is that creating the community is very easy. And it’s something you’ll do once or occasionally. So a scripted approach is more efficient than writing code.
Let’s get to it. For reference, review the cURL scripts I have laying around in cURLConnectionsCloud.zip. Just unzip it to any Windows computer.
Every cURL script I create starts with some setup to initialize parameters like server URL, username, and password. The first time you run the scripts, it will prompt for user name and password. Anything run subsequently will be done in the context of this user name (e.g. My Communities).
The below command sets the path to the cURL executable. It also ensures that basic authentication is used and the username:password pair are included any time a Connections Cloud script is run.
set curl=%~dp0/curl/curl.exe -L -k -u %cnx_username%:%cnx_password%
This script set the URL to the server. It also prompts the user for credentials if not already provided previously.
@echo off REM CA1 Test Server REM set cnx_url=https://apps.collabservnext.com REM North America Production Server set cnx_url=https://apps.na.collabserv.com IF DEFINED cnx_url (echo %cnx_url%) ELSE (set /p cnx_url= Connections URL:) IF DEFINED cnx_username (echo %cnx_username%) ELSE (set /p cnx_username= Connections ID:) IF DEFINED cnx_password (echo **masked**) ELSE (set /p cnx_password= Connections Password:)
Next we need to create a community. This is done simply by sending text to the Connections Cloud server.
The cURL script looks like the following.
@echo off call ../SetupCnx.bat call ../SetupCurl.bat %curl% -v -X POST --data-binary @%1 -H "Content-Type: application/atom+xml" %cnx_url%/communities/service/atom/communities/my
A couple of points:
- -v is the verbose flag; I use it to see everything that happens. You can remove it if you’d like
- –data-binary @%1 means that I am sending a file to the server and the file name is provided as input on the command line
- -H “Content-Type: application/atom+xml” is a required setting; you need to set a header specifying the content type per the API doc
- %cnx_url%/communities/service/atom/communities/my is the URL to the Connections endpoint per the API doc
To create the community, all that’s needed is to create an XML file and run the following command.
C:\IBM\workspaces\connections\cURL\communities>CreateCommunity.bat CommunityInpu t.xml
The above command has CommunityInput.xml at the end. This is the input file that is used to create the community. The input XML file is easy on the eyes as well. If we had multiple communities, I would write a few more lines in the script to substitute the list of folders for the title field. Or you could create more input files … it’s a lot easier to edit text than program.
<?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns:snx="http://www.ibm.com/xmlns/prod/sn"> <title type="text">Community Name Goes Here</title> <content type="html">Community Description Goes Here</content> <author> <name>Van Staub</name> <email>firstname.lastname@example.org</email> <snx:userid>20002888</snx:userid> <snx:userState>active</snx:userState> </author> <contributor> <name>Van Staub</name> <email>email@example.com</email> <snx:userid>20002888</snx:userid> <snx:userState>active</snx:userState> </contributor> <category term="community" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category> <snx:communityType>public</snx:communityType> </entry>
I’ve boldfaced the areas you might want to change. But use the API doc as a guide of what you can additionally set. Most importantly the snx:userid applies to either your GUID for Connections on-premises or your subscriber ID for Connections Cloud.
- Unzip my sample.
- Update the CommunityInput.xml.
- Run CreateCommunity.bat
So next time you need to get something completed quickly or just want to experiment with the APIs, take a look at the cURL scripts I posted. Most of them should work …