Administration Guide#

Administer a Reportworq 5 server: authentication, workspaces, application settings, audit logs, upgrades, migration and load balancing, plus every datasource, distributor, report provider and AI connection.

• Migrating Reportworq - Many users will at some point find that they need to move Reportworq to a new location. The following steps will help successfully migrate Reportworq to a new server without losing the users created...
• Authentication - All users who log in to Reportworq require authentication credentials and licenses. By default, Reportworq uses its native authentication provider. Alternatively, you can configure Reportworq to use...
• Audit Log - ReportWORQ provides two distinct audit logging systems that together give administrators full visibility into both system-level activity and job execution history:
• Configuration - The Configuration page of the Administration interface contains settings related to the following:
• Load Balancer - Overview The Load Balancer allows Reportworq to distribute the workload of running jobs across multiple servers. The number of jobs that can run concurrently is configured independently for each...
• Microsoft 365 - Reportworq can integrate with select Microsoft 365 resources including SharePoint, Teams, Email, and Entra Authentication. To set up authentication between Reportworq and Microsoft 365, you register...
• Reportworq API - Reportworq supports several automation options that can be used to run Reportworq Jobs from other scheduling platforms, scripting languages, and applications. Reportworq's automation is not meant to...
• Upgrading Reportworq - There are three methods of upgrading Reportworq:
• Workspaces - Reportworq Workspaces enable organizations to provide separate working environments to each team, role, or department as required. Each Reportworq user can access resources for their Workspace(s)...

Report Providers#

• Report Providers Overview - Reportworq only permits the use of reporting content from trusted locations, which are defined as Report Providers. Report Providers ensure that report distribution jobs created by Reportworq users...
• Network Share - Network Share Report Providers are used in Reportworq to make existing folders and reports from the file system available for developing and executing Reportworq report distribution jobs. Reportworq...
• SharePoint Documents - The SharePoint Report Provider can be used to store files and folders in SharePoint and to use these files for developing and executing report Distribution Jobs. The SharePoint Report Provider...
• Google Drive - Google Drive Report Providers are used in Reportworq to access existing folders and files in Google Drive for developing and executing Reportworq report distribution jobs. Each Google Drive Report...
• Reportworq Drive - Reportworq offers a built-in Drive. The Reportworq Drive option allows users to store files and folders in the related Source Report Connection folder. Disabling a built-in provider will not delete...
• IBM Planning Analytics - The IBM Planning Analytics Report Provider enables users to select source reports from the Application Folders section of any available Planning Analytics connection.
• OneDrive Documents - The OneDrive Report Provider lets you use report files stored in the connected Microsoft 365 service account’s personal OneDrive (/me/drive) as the source for Distribution Jobs. Reportworq uses the...
• Box Documents - The Box Report Provider lets you use report files stored in your organization’s Box account as the source for Distribution Jobs. Once the Box connection is configured, your Box folders become...

Distributors#

• Distributors Overview - Reportworq offers multiple ways of disseminating information to targeted recipients, and these methods are defined as Distributors. Distributors provide an efficient and repeatable means of...
• IBM Planning Analytics - Reports can be distributed to Planning Analytics TM1 application folders.
• Google Drive - The following steps must be performed to enable Reportworq distribution to Google Drive:
• Email - Reportworq administrators can open the Administration screen from the Administration button on the top right side of the page and edit Email settings.
• Network Folder - Reportworq administrators can open the Administration screen from the Administration button on the top right side of the page and edit Network Share settings.
• SharePoint - The ability to distribute files to SharePoint from Reportworq is achieved through the use of stored SharePoint login credentials. The user name (version dependent) and password are the credentials...
• Secure FTP - You can configure a Reportworq Distributor to deliver output files securely to a remote folder via SFTP server.
• Slack - You can create a Slack Distributor that distributes reports via a Slack app.
• Teams - Reportworq provides two different paths to distribute messages, images and files to Microsoft Teams.
• OneDrive - The OneDrive distributor delivers the files a job generates straight into a folder of the configured Microsoft 365 service account’s personal OneDrive (/me/drive), with an optional toggle to share...
• Box - The Box distributor delivers the files a job generates straight into a folder in your organization’s Box account, creating any folders in the destination path on the fly and versioning files that...

Datasources#

• Datasources Overview - A Reportworq Datasource is a set of connection credentials that provide access to a data source. When a Distribution Job runs or Contribution input forms are generated, Reportworq uses Datasource...
• IBM Planning Analytics - Reportworq supports the refresh of Excel-based reports created using the IBM Planning Analytics Perspectives and Planning Analytics for Excel (PAfE) Excel add-ins. These reports use proprietary...
• Workday Adaptive Planning - Reportworq supports the refresh of Excel-based reports created using the Workday Adaptive Planning OfficeConnect Excel add-in. These reports use specifications that are embedded into hidden...
• Anaplan - Reportworq supports the refresh of Excel-based reports created using the Anaplan Excel add-in. These reports use specifications that are embedded into hidden properties on each worksheet. Reportworq...
• Pigment - Reportworq supports a connection to Pigment. Pigment is a modern business planning platform designed to replace traditional spreadsheet-based forecasting with a centralized, real-time environment.
• SQL Sources - Microsoft Excel supports several different types of data connections, data models, and power query modeling features. These data connections are often used to load relational database data into an...
• Oracle EPM Cloud - Reportworq supports the refresh of Excel-based reports that have been created using the Oracle Smart View Excel add-in using data in Oracle EPM Cloud. These reports use specifications that are...
• Power BI - This article describes how to configure a Microsoft Power BI datasource in Reportworq using the CData ADO.NET Provider for Microsoft Power BI XMLA.
• Power BI - ADOMD Connection - Configuring a Microsoft Power BI (ADOMD) Datasource
• Salesforce - Reportworq supports the refresh of Excel-based reports created using data from Salesforce. Reportworq Administrators can add and configure an Salesforce Datasource.

AI Connections#

• AI Connections Overview - AI connections enable you to add AI Generated Insights to Distribution Job output messages.
• Microsoft Azure OpenAI - This article describes how to connect to a deployed Microsoft Azure OpenAI model.
• Amazon Bedrock - This article describes how to connect to an Amazon Bedrock AI model.
• OpenAI - This article describes how to connect to an OpenAI model.