Skip to content

Configuring OGDI for Deployment in Windows Azure

SyntaxC4 edited this page Mar 6, 2012 · 35 revisions

#Configuration Keys

In order for OGDI to be able to store the data and communicate with it's external components, some assembly is required. This document will provide the default values, as well as a description to identify what each setting is responsible for.

The configuration values are found in the following files:

  • %OGDI_ROOT%\InteractiveSDK\InteractiveSDK.Mvc
    • ServiceConfiguration.Cloud.cscfg
    • ServiceConfiguration.Local.cscfg

Note: the DataService Cloud Project is available, but not used in the default configuration.

  • %OGDI_ROOT%\DataService\Services

    • ServiceConfiguration.Cloud.cscfg
    • ServiceConfiguration.Local.cscfg
  • %OGDI_ROOT%\InteractiveSdk\Interactive Sdk.Mvc_WebRole
    • Web.config
      • Web.Debug.config
      • Web.Release.config
  • %OGDI_ROOT%\DataService\Services_WebRole
    • Web.config
      • Web.Debug.config
      • Web.Release.config

##Data Browser [Web Role]

The following configuration values are required to configure the Data Browser component.

Note: The current default configuration is overloading a single Windows Azure instance with the Data Browser and Data Service, some duplication will occur with the Data Service section below.

###ServiceUri

Default value

The ServiceUri is a replacement configuration which identifies the endpoint for the Data Service. By default, the DataService is deployed along side the Data Browser so the [DataServiceDNS] token would be changed to the dns name of the Windows Azure Hosted Service which contains the Data Browser.

Note: Due to the way the Windows Azure Compute Emulator functions, your default ServiceUrl may not reflect the proper port on Debug.

If the Data Service is under high load, split the Data Service off to the Cloud Project as explained in the Data Service Cloud Project Readme.

###PathDTD

Default value

  • Local: XMLValidation\dtbook-2005-3.dtd
  • Cloud: XMLValidation\dtbook-2005-3.dtd

Path to the Daisy Document Type Definition file.

###HeaderLogo

Default value

  • Local: ../../Images/CloudBanner2.png
  • Cloud: ../../Images/CloudBanner2.png

Path to the header logo (image).

###HeaderLogoAltText

Alternate Text for the header logo.

###HeaderLogoLongDesc

Default value

  • Local: ../../Descriptions/Load.txt
  • Cloud: ../../Descriptions/Load.txt

Path to a text file with "Loading" message.

###HeaderBackground

Default value

  • Local: ../../Images/HeadBG.gif
  • Cloud: ../../Images/HeadBG.gif

Path to the header background image.

###FooterBackground

Default value

  • Local: ../../Images/footer.gif
  • Cloud: ../../Images/footer.gif

Path to the footer background image.

###BannerImage

Default value

  • Local: ../../Images/example.png
  • Cloud: ../../Images/example.png

Image to float in top right of screen. [removed in current release]

###TermsOfUseURL

Default value

Link to the Terms of use.

###TradeMarksURL

Default value

Link to the Trademark.

###CopyRightsStatement

Default value

  • Local: 2010 Microsoft Corporation. All rights reserved.
  • Cloud: 2010 Microsoft Corporation. All rights reserved.

Copyright statement. [Text/Html]

###PrivacyPage

Default value

####Local <H1>Privacy Statement </H1><DIV class=welcomecontent><P class=big>At Microsoft, we are committed to protecting your privacy. This Web site does not request or collect any personal information from you. This site may collect certain anonymous information about your visit, such as the name of the Internet service provider and the Internet Protocol (IP) address through which you access the Internet; the date and time you access the site; the pages that you access while at the site and the Internet address of the Web site from which you linked directly to our site. This information is used to help improve the site, analyze trends, and administer the site. </P><P class=big>Please note that this privacy statement applies only to the Open Government Data Initiative website. It does not apply to other online or offline Microsoft sites, products or services. </P><P class=big>This site may contain links to other sites and services. We encourage you to review the privacy statements of those sites and services that you choose to visit, so that you can understand how they may collect, use and share your personal information. Microsoft is not responsible for the privacy statements or practices of sites and services controlled by other companies or organizations. </P><P class=big>Click <A href="http://privacy.microsoft.com/en-us/default.mspx" target=_blank>here</A><IMG alt="External Link" src="../../images/ExternalLink.png"> for more information on Microsoft's commitment to privacy. </P><P></P></DIV> ####Cloud Same.

This text will be placed on the Privacy page. [Text/Html]

###HomePageHeading

Default value

####Local <h1>Welcome to Open Government Data Initiative (OGDI)</h1> ####Cloud <h1>Welcome to Open Government Data Initiative (OGDI)</h1>

The title of the instance of OGDI. [Text/Html]

###WelcomeVideoURL

Default value

Video to be displayed on the home page.

###HomePageContent

Default value

####Local <p class="big">The Open Government Data Initiative (OGDI) is an initiative led by Microsoft <A href="http://blogs.msdn.com/publicsector/default.aspx" target=_blank>Public Sector Developer Evangelism team</A><IMG alt="External link for Public Sector Developer Evangelism team" src="/images/ExternalLink.png" longDesc="desc/Publicsector.txt">. OGDI uses the <A href="http://www.windowsazure.com" target=_blank>Windows Azure Platform</A><IMG alt="External link for Windows Azure Platform" src="/images/ExternalLink.png" longDesc="desc/azureservices.txt"> to make it easier to publish and use a wide variety of public data from government agencies. OGDI is also a free, open source 'starter kit' with <A href="http://ogdi.codeplex.com" target=_blank>code</A><IMG alt="External link for OGDI project on CodePlex.com" src="/images/ExternalLink.png" longDesc="desc/codeplex.txt"> that can be used to publish data on the Internet in a Web-friendly format with easy-to-use, open API's. OGDI-based web API's can be accessed from a variety of client technologies such as Silverlight, Flash, JavaScript, PHP, Python, Ruby, mapping web sites, etc.</p><p class="big">Whether you are a business wishing to use government data, a government developer, or a 'citizen developer', these open API's will enable you to build innovative applications, visualizations and mash-ups that empower people through access to government information. This site is built using the OGDI starter kit software assets and provides interactive access to some publicly-available data sets along with sample code and resources for writing applications using the OGDI API's. </p><p class="big">Email us at <A href="mailto:askogdi@microsoft.com">askogdi@microsoft.com</A> if you have government data sets that you would like us to publish or if you have other questions.</p> ####Cloud Same.

The HTML content for the Home About page.

###BlogPostsUrl

Default value

A url which points to an RSS feed of a blog in which you would like to display on the Home About page.

###NumberOfBlogLinksOnPage

Default value

  • Local: 3
  • Cloud: 3

Number of entries from the BlogPageUrl to show on the Home About page.

###RootServiceNamespace

Default value

  • Local:
  • Cloud:

###DataConnectionString

Default value

  • Local:
  • Cloud:

###DiagnosticsConnectionString

Default value

  • Local:
  • Cloud:

###RecaptchaPrivateKey

Default value

  • Local:
  • Cloud:

###RecaptchaPupblicKey

Default value

  • Local:
  • Cloud:

##Data Service [Web Role]

The following configuration settings are required for the Data Service.

Note: The Data Service is bundled by default with the Data Browser, these values will be duplicated.

###RootServiceNamespace

Default value

  • Local:
  • Cloud:

###DataConnectionString

Default value

  • Local:
  • Cloud:

###DiagnosticsConnectionString

Default value

  • Local:
  • Cloud:

##Data Browser [Worker Role]

The following configuration settings are required by the Data Browser Worker Role.

###DiagnosticsConnectionString

Default value

  • Local:
  • Cloud:

###DataConnectionString

Default value

  • Local:
  • Cloud:

###SmtpSettings

Default value

  • Local:
  • Cloud:

###ServiceUri

Default value

  • Local:
  • Cloud:

###PathDTD

Default value

  • Local:
  • Cloud: