Generating documents for use with the document visibility feature

This is an attention message.

This article details the steps to be followed to properly configure create documents and report subscriptions using APIs, for the purpose of using them in the (Undefined variable: CompoVariables_WA.Inbox), with the document visibility feature.

For more information about the document visibility feature in the (Undefined variable: CompoVariables_WA.Inbox), see .

Forewarning

While it is possible to create documents from the Admin Portal interface, documents generated using this method cannot be used with the document visibility feature. Only documents generated via APIs are eligible.

Documents generated through APIs can still be used without the document visibility feature.

For more information about the generation of documents using the Admin Portal interface, see Creating an SSRS report subscription.

This article assumes that you have already created the parameter table to be used as the foundation for the documents to be generated. For more information about the creation and configuration of the parameter report, refer to Managing report subscriptions with APIs.

Generating Documents

The following method is used to create a new report communication entry.

In order to use this method, your profile must have been granted the "Create" permission for "Communication Workbench" (in Admin Portal, under (Undefined variable: CompoVariables_AP.Admin2) > <Functional Admin > ProfileName> > Info Hub > Communication Workbench).

This is an note/information message.

Each time a new report entry is created, a subscription is also automatically generated.

Service	Action	Endpoint	Output Sample
Gateway	POST	/api/report-communication/	{Report Communication Item without id property}

List of Available Parameters

This section details all the supported parameters to use to correctly execute the APIs methods.

Parameter	Data Type	Info
id	Integer	Parameter form the nc_report table, included in GET requests but not taken into consideration for POST or PUT requests.
idFolder	Integer	Optional. This parameter is from the nc_report table. If not provided, -5 (root folder) is used
title	String	Mandatory. This is the report title.
description	String	Optional.
idReport	Integer	Mandatory. This parameter is from the k_reports table.
beginDate	DateTime	Optional.
endDate	DateTime	Optional.
receiver	Integer	Mandatory. Identifier of the population.
idParameterTable	Integer	Mandatory. This parameter is from the k_referential_tables_views table (find the registered parameter table previously created).
filteTemplateName	String	Mandatory (e.g. @PayeeCode@LastName)
format	String	Mandatory. The available formats are: "pdf", "excel" or "word".
period	String	Mandatory. The available periods are: "onetime", "week", "hour", "day" and "month".
day	Integer	Mandatory if the period is "week", "day" or "month"
hour	Integer	Mandatory if the period is "onetime".
zipEnabled	Boolean	Optional; false by default.
zipPdfGenerationEnabled	Boolean	Optional; false by default.
zipReceiver	Integer	Optional. Identifier of the population.
hideAsDefault	Boolean	Optional; false by default. Used for document visibility management in the (Undefined variable: CompoVariables_WA.Inbox). To be used to generate documents, but not display them in Web App. Fore more information about the use of the document visibility feature, refer to Generating documents for use with the document visibility feature. This is a warning message. beqom recommends that you do not use this parameter. When documents are generated with this parameter set to true, the only possibility to make documents available at a later moment is to change their status in the database.
teamReviewAllowed	Boolean	Optional. Used for document visibility management in the (Undefined variable: CompoVariables_WA.Inbox). To be used to allow the visibility of generated documents to be managed using the document visibility feature in (Undefined variable: CompoVariables_WA_Alternate."Inbox"). Fore more information about the use of the document visibility feature, refer to Generating documents for use with the document visibility feature.
useProfileAccess	Boolean	Optional; false by default. Used for document visibility management in the (Undefined variable: CompoVariables_WA.Inbox). To be used to limit the visibility of documents to certain profiles only. This parameter is checked by the application when the logged in user opens the "Team Documents" tab and when they attempt to grant access (individually or in bulk) or revoke access (individually or in bulk) to the documents using the Web App interface.
profileAccess	String	Optional. Use array. Used for document visibility management in the (Undefined variable: CompoVariables_WA.Inbox). To be used to define the list of profiles that will have access to generated documents, when useProfileAccess is set to true. Values must be taken from the primary key in k_profiles. This parameter is checked by the application when the logged in user opens the "Team Documents" tab and when they attempt to grant access (individually or in bulk) or revoke access (individually or in bulk) to the documents using the Web App interface.

Updating the Profile Access Configuration of a Communication Entry

When document have been generated with a certain specification regarding profile access, it is still possible to change the profile access configuration afterward in order to add or remove profiles.

To do so, use the method outlined below.

In order to use this method, your profile must have been granted the "Modify" permission for "Communication Workbench" (in Admin Portal, under (Undefined variable: CompoVariables_AP.Admin2) > <Functional Admin > ProfileName> > Info Hub > Communication Workbench).

Service	Action	Endpoint	Body Sample
Gateway	PUT	/api/report-communication/{id}/profile-access	Copy { "useProfileAccess":Boolean, "profileAccess":[Integer] }

Known Limitations

The following parameters are preset and cannot be changed since they are currently not requested from the API endpoints:

• idType (1 for "link" and 2 for "file generation"): always 2
• extensionType (1 for "email" and 2 for "file share"): always 2
• useTranslation (boolean): always false

This is a tip message.

For complete information about the APIs used to manage documents and report subscriptions, refer to Managing report subscriptions with APIs.