Integrations and APIs for Service

Get Involved. Join the Conversation.

Topic

    Charlie Mopps
    ROQL Documentation?
    Topic posted July 26, 2013 by Charlie MoppsGold Medal: 3,500+ Points 
    1201 Views, 10 Comments
    Title:
    ROQL Documentation?
    Content:


    I'm attempting to do some rather complicated stuff using the API and ROQL. Unfortunately the documenation I've found on ROQL so far is terrible.

    I need information on how to do more than basic querries.

    For example:

    How do you do

    SHOW COLUMNS
    or
    DESCRIBE Account
    or
    SHOW TABLES
     

    and every other administrative command that I can use in ODBC? Unfortunately ROQL seems to have relabled the majority of the fields and table names so getting them right is a guessing game until I can figure out how to get it to just spit out a list for me.

    If anyones got any of this to work, I'd love to hear how.

     

    Thanks!

     

    Comment

     

    • Jorge Garcia gallardo

      even though the post is old, I answer: There is no direct equivalence between all the SQL commands and ROQL. So there are no such things like SHOW or DESCRIBE in ROQL. but you can BTW try to do the same by accessing metadata info with the appropriate commands.

    • Allan Schrum

      DESCRIBE was added in the May 2014 release of our product. It can be used with CWSS QueryCSV or CPHP ROQL::query(). You can use it to describe objects, or paths to objects:

      DESCRIBE Contact
      DESCRIBE Contact.Emails.EmailList

      Regards,

      -Allan

    • Charlie Mopps

      I figured this out on my own. I wish there was a way to see patch notes or something... or get on a mailing list for this sort of thing.

    • Allan Schrum

      This was documented in the "Release Notes" section in the documentation.

      Regards,

      -Allan

    • Charlie Mopps

      This provides an excellent opportunity for me to help Oracle/Rightnow understand some of the difficulties we have with your documentation.

      Here's a link to your release notes: https://documentation.custhelp.com/euf/assets/docs/may2014/olh/wwhelp/wwhimpl/js/html/wwhelp.htm?href=May2014_release_notes.3.1.html

      Without using whatever internal tools you have, try and read through that and tell me where and how I'd find this information. I found 2 mentions of the "DESCRIBE" function in the entire document. On one, it's shown in a screenshot of a help window. In the other it's in an example query. I can't find any mention of "We added DESCRIBE to ROQL!" at all. This is the only direct mention of it that I can find: https://documentation.custhelp.com/euf/assets/docs/may2014/olh/wwhelp/wwhimpl/common/html/wwhelp.htm?context=crm&file=admin.73.27.html

      And I know exactly what I'm looking for.

      ...and this is assuming I'm upgrading to May 2014. We didn't. We skipped to a newer one, never touched this release.... When we upgrade I have to collate a list of all of the updates from all of the releases between our current version and the one we're upgrading to. Given the way these release notes are written, there's no way I could ever find something like this. It's just not possible.

      We use a lot of software packages from a lot of other sources, including Oracle, and most release notes read like a bullet pointed list:

      http://dev.mysql.com/doc/relnotes/mysql/5.6/en/

      http://docs.oracle.com/cd/E11882_01/relnotes.112/e23558/toc.htm#CHDIAEBD

      This is what we need. You sort of have a "Major changes" section that's bullet pointed, but that often leaves out some fairly major enhancements like this one.

       

       

       

    • Chris Omland

      Hi Jerry,

      I agree we can do a better job here. We are always evaluating ways to improve and will take this into consideration. The release notes Allan is referring to our in our developer documentation. Here is a link to the May 2014 release notes where Describe is called out.

      http://documentation.custhelp.com/euf/assets/devdocs/may2015/Connect_Web_Services_for_SOAP/Content/Release%20Notes/Oracle%20RightNow%20CX%20May%202014.htm

    • Charlie Mopps

      ah... see, I had no idea that even existed.  How do I access those notes? I can't find them anywhere on your site. I even did multiple searches and nothing comes up. I can't find them anywhere.

    • Allan Schrum

      Go to the regular documentation web page and only the left-hand side there is a list of different sections to review. The bottom link is "Release Notes" which contains all the release notes for each of the releases as well as links to the older versions of the documentation.

      Regards,

      -Allan

    • Chris Omland

      Here is a direct link to the developer documentation if it helps:

      https://cx.rightnow.com/app/answers/detail/a_id/5169

    • Charlie Mopps

      Ohh... it's in the SOAP Developer guide?

      So this brings up another point. If it's in there... it's completely unsearchable. From your website, from google, it just doesn't exist. As well as any other information in the guide for that matter. That explains why I couldn't find it. If it were a standard HTML page, I could have found it with ease.

      Ok, I'm done bothering you now. I can read through it now that I know where it's at. Thanks!