Create A Support Ticket

Please use the form below to submit a support request.

    Upload a file (optional)

    Please or Register to create posts and topics.

    Feature Highlight - IBM Planning Analytics REST API Integration

    IBM Planning Analytics has built-in capabilities, such as its TurboIntegrator ETL tool, that are well-suited to automating the execution of ReportWORQ Jobs.

    Historically, ReportWORQ has supported two methods of triggering jobs:

    • Through a TI process, actively calling the ReportWORQ REST API

    • Passively through using Cube Monitoring, in which ReportWORQ polls a cube for job execution requests

    Direct REST API integration through a TI process was previously limited to Self Hosted connections, which cube monitoring was designed for IBM PA Cloud (primarily) or Self Hosted connections.

    We’re happy to announce a new TI process to kick off ReportWORQ jobs from IBM PA Cloud. This new TI process supersedes Cube Monitoring, and is a more direct way to execute a ReportWORQ job from IBM Cloud.

    How to use the new TI process

    The new TI process is named ’ReportWORQ - Rest API Run Job Sample - Cloud - 1.0?. This new process runs a ReportWORQ job by using ReportWORQ’s Cloud Connector as an API relay; IBM Cloud sends a request to the publicly available Cloud Connector, which sends a request to the ReportWORQ instance.

    Installation and use of this new TI process is similar to the local version of the same TI process, ’ReportWORQ - REST API Run Job Sample 2.1?. It’s installed via the ’Install REST API TI Process? button on the ’Advanced Options? tab of the PA data source.

    • The TI process takes the following arguments:

      • pApiUrl

      • pCloudConnectorApiKey

      • pJobName

      • pWorkspaceName

      • pNotificationEmail

      • pHoldForDelivery

      • pAllowedFileOutputTypes

      • pAllowedDestinationTypes

      • pConvertPowerPointToPdf

      • pTlsSecurity

    • These are all identical to the local TI arguments, except:

      • pApiUrl
      • pCloudConnectorApiKey
        • This is the Cloud API key that can be configured in ReportWORQ, as opposed to the Local API key
      • pWorkspaceName
        • This is the name of workspace where job lives. If only one workspace exists for the RW install (this is the default), this parameter is optional.

    The TI process will write out job requests/logs in a similar way to the local version of the process. These are, by default, written to a ’ReportWORQ? folder within the PA instance’s ’data? folder. This is configurable within the TI process.

    This TI process also automatically creates a PowerShell script (’ReportWORQ_RunAPIJob.ps1?) within this folder, that the TI process runs to make the call to Cloud Connector.

    Upgrading from Cube Monitoring

    With the creation of this new TI process, Cube Monitoring is now deprecated; we still support it, but moving forward all new installs should use this new TI process.

    We would recommend that any customers who have issues with cube polling should upgrade to this new TI process.

    Upgrading will consists of making sure that uses of the old cube monitoring TI are replaced in PA models by the new TI and making sure any arguments are passed correctly to the new TI. I.e., making sure parameter overrides are passed correctly.