Agent PushReportSubscriptions - Revision history

Sofial at 09:28, 20 March 2023

2023-03-20T09:28:36Z

← Older revision		Revision as of 09:28, 20 March 2023
Line 119:		Line 119:
	# Select the report '''format'''; ''PDF'' or ''Excel''		# Select the report '''format'''; ''PDF'' or ''Excel''
	# Define the '''file name''' for the generated report		# Define the '''file name''' for the generated report
	# Define the '''path''' where the report is to be placed when using the file share function, make sure the file ~~patch~~ is shared on the server with the correct user		# Define the '''path''' where the report is to be placed when using the file share function, make sure the file path is shared on the server with the correct user
	# Define the report selection according to the information for that specific report		# Define the report selection according to the information for that specific report
	# Click '''save'''		# Click '''save'''

Sofial at 09:27, 20 March 2023

2023-03-20T09:27:17Z

← Older revision		Revision as of 09:27, 20 March 2023
Line 119:		Line 119:
	# Select the report '''format'''; ''PDF'' or ''Excel''		# Select the report '''format'''; ''PDF'' or ''Excel''
	# Define the '''file name''' for the generated report		# Define the '''file name''' for the generated report
	# Define the '''path''' where the report is to be placed when using the file share function		# Define the '''path''' where the report is to be placed when using the file share function, make sure the file patch is shared on the server with the correct user
	# Define the report selection according to the information for that specific report		# Define the report selection according to the information for that specific report
	# Click '''save'''		# Click '''save'''

Sofial: Marked this version for translation

2023-02-13T11:32:57Z

Marked this version for translation

← Older revision		Revision as of 11:32, 13 February 2023
Line 1:		Line 1:
	<translate>		<translate>
	== Manage Subscriptions for Scheduled Reports ==		== Manage Subscriptions for Scheduled Reports == <!--T:1-->

			<!--T:2-->
	In this view you get an overview of all subscriptions, history, and schedules of a specific report.		In this view you get an overview of all subscriptions, history, and schedules of a specific report.

			<!--T:3-->
	The subscriptions tab is where you can create new subscriptions or edit the existing ones. You have the possibility to filter user defined subscriptions, i.e. the subscriptions that the end users themselves manage directly in each report selection page.		The subscriptions tab is where you can create new subscriptions or edit the existing ones. You have the possibility to filter user defined subscriptions, i.e. the subscriptions that the end users themselves manage directly in each report selection page.

			<!--T:4-->
	Normally you set up a schedule for the subscription, defining when and how often the report is to be generated. It's also possible to run the subscription manually.		Normally you set up a schedule for the subscription, defining when and how often the report is to be generated. It's also possible to run the subscription manually.


			<!--T:5-->
	Subscriptions tab display:		Subscriptions tab display:

			<!--T:6-->
	{\|		{\|
	\|-		\|-
Line 42:		Line 47:


			<!--T:7-->
	If you want to stop a subscription, there are different ways to do it depending on what you want to achieve. If it's temporary, you can either disable the subscription totally or disable one or more of the subscription schedules. If it's permanent, you can delete the whole subscription.		If you want to stop a subscription, there are different ways to do it depending on what you want to achieve. If it's temporary, you can either disable the subscription totally or disable one or more of the subscription schedules. If it's permanent, you can delete the whole subscription.

			<!--T:8-->
	To stop a running subscription, click [[Image:Icon Cancel.png]].		To stop a running subscription, click [[Image:Icon Cancel.png]].


			<!--T:9-->
	'''Note:''' Subscriptions marked in red are updated with new or removed settings, to activate the subscription again open subscription and press save.		'''Note:''' Subscriptions marked in red are updated with new or removed settings, to activate the subscription again open subscription and press save.


	=== How to - Show Scheduled Report Subscriptions ===		=== How to - Show Scheduled Report Subscriptions === <!--T:10-->

			<!--T:11-->
	# Click the [[{{Link}}ApplikationAdmin Default\|role Application Maintenance]]		# Click the [[{{Link}}ApplikationAdmin Default\|role Application Maintenance]]
	# Click '''Push email settings > Scheduled reports'''		# Click '''Push email settings > Scheduled reports'''
Line 58:		Line 67:


	=== How to - Add a New Subscription ===		=== How to - Add a New Subscription === <!--T:12-->

			<!--T:13-->
	# Click '''add''' [[Image:Icon Add.png]]		# Click '''add''' [[Image:Icon Add.png]]
	# Select which [[{{Link}}Main_Group\|main group]] the scheduled report should belong to		# Select which [[{{Link}}Main_Group\|main group]] the scheduled report should belong to
Line 82:		Line 92:


	=== How to - Set Up an Email Subscription ===		=== How to - Set Up an Email Subscription === <!--T:14-->

			<!--T:15-->
	# Enter the email address to the receiver in the '''to''' field		# Enter the email address to the receiver in the '''to''' field
	#:* If there are more than one receiver, enter the addresses separated by semicolons		#:* If there are more than one receiver, enter the addresses separated by semicolons
Line 103:		Line 114:


	=== How to - Set Up a Windows File Share Subscription ===		=== How to - Set Up a Windows File Share Subscription === <!--T:16-->

			<!--T:17-->
	# Select the report '''format'''; ''PDF'' or ''Excel''		# Select the report '''format'''; ''PDF'' or ''Excel''
	# Define the '''file name''' for the generated report		# Define the '''file name''' for the generated report
Line 113:		Line 125:


	=== How to - Edit an Existing Subscription ===		=== How to - Edit an Existing Subscription === <!--T:18-->

			<!--T:19-->
	# Click on the name of the subscription you want to edit		# Click on the name of the subscription you want to edit
	#:* The ''Edit subscription'' view is displayed		#:* The ''Edit subscription'' view is displayed
Line 122:		Line 135:


	=== How to - Disable/Enable a Subscription ===		=== How to - Disable/Enable a Subscription === <!--T:20-->

			<!--T:21-->
	# Click on the name of the subscription you want to disable/enable		# Click on the name of the subscription you want to disable/enable
	# Change the '''enabled''' setting for the subscription		# Change the '''enabled''' setting for the subscription
Line 131:		Line 145:


	=== How to - Delete a Subscription ===		=== How to - Delete a Subscription === <!--T:22-->

			<!--T:23-->
	# Check the box for each subscription you want to delete		# Check the box for each subscription you want to delete
	# Click the icon [[Image:Icon Links.png]] to open the action menu in the toolbar above the table, and select delete		# Click the icon [[Image:Icon Links.png]] to open the action menu in the toolbar above the table, and select delete
Line 138:		Line 153:


	=== How to - Run a Subscription Manually ===		=== How to - Run a Subscription Manually === <!--T:24-->

			<!--T:25-->
	# Click '''run''' [[Image:Icon Run.png]] for the subscription you want to run instantly (the report will be generated and sent out by email or placed on the server according to the subscription settings)		# Click '''run''' [[Image:Icon Run.png]] for the subscription you want to run instantly (the report will be generated and sent out by email or placed on the server according to the subscription settings)
	#:* Click '''cancel''' [[Image:Icon Cancel.png]] if you like to cancel your scheduled report		#:* Click '''cancel''' [[Image:Icon Cancel.png]] if you like to cancel your scheduled report
Line 145:		Line 161:


	=== How to - Create or Edit the Schedules of the Subscriptions ===		=== How to - Create or Edit the Schedules of the Subscriptions === <!--T:26-->

			<!--T:27-->
	# To edit the schedules of how often the report is to be generated, click the [[{{Link}}Agent PushReportSchedules\|schedules]] tab		# To edit the schedules of how often the report is to be generated, click the [[{{Link}}Agent PushReportSchedules\|schedules]] tab


	=== How to - Check Subscription History ===		=== How to - Check Subscription History === <!--T:28-->

			<!--T:29-->
	# To check the subscription history, click the [[{{Link}}Agent PushReportHistory\|History]] tab		# To check the subscription history, click the [[{{Link}}Agent PushReportHistory\|History]] tab


	=== How to - Send E-mail to Subscription Recipients ===		=== How to - Send E-mail to Subscription Recipients === <!--T:30-->

			<!--T:31-->
	# Check the box for each subscription you want to send a message to, based on subscription recipients		# Check the box for each subscription you want to send a message to, based on subscription recipients
	#:* All recipients from the subscription will receive the email		#:* All recipients from the subscription will receive the email
Line 165:		Line 184:


	=== How to - Check Send E-mail to Subscription Recipients History ===		=== How to - Check Send E-mail to Subscription Recipients History === <!--T:32-->

			<!--T:33-->
	# To check the history for '''Send E-mail to Subscription Recipients''', click the [[{{Link}}Agent PushReportHistory\|History]] tab		# To check the history for '''Send E-mail to Subscription Recipients''', click the [[{{Link}}Agent PushReportHistory\|History]] tab


			<!--T:34-->
	'''Note:''' History about ''Send E-mail to Subscription Recipients'' is only updated in the e-mail section on the History tab		'''Note:''' History about ''Send E-mail to Subscription Recipients'' is only updated in the e-mail section on the History tab

Sofial: Created page with " == Manage Subscriptions for Scheduled Reports == In this view you get an overview of all subscriptions, history, and schedules of a specific report. The subscriptions tab is where you can create new subscriptions or edit the existing ones. You have the possibility to filter user defined subscriptions, i.e. the subscriptions that the end users themselves manage directly in each report selection page. Normally you set up a schedule for the subscription, de..."

2023-01-17T08:37:50Z

Created page with "<translate> == Manage Subscriptions for Scheduled Reports == In this view you get an overview of all subscriptions, history, and schedules of a specific report. The subscriptions tab is where you can create new subscriptions or edit the existing ones. You have the possibility to filter user defined subscriptions, i.e. the subscriptions that the end users themselves manage directly in each report selection page. Normally you set up a schedule for the subscription, de..."

New page

<translate>
== Manage Subscriptions for Scheduled Reports ==

In this view you get an overview of all subscriptions, history, and schedules of a specific report.

The subscriptions tab is where you can create new subscriptions or edit the existing ones. You have the possibility to filter user defined subscriptions, i.e. the subscriptions that the end users themselves manage directly in each report selection page.

Normally you set up a schedule for the subscription, defining when and how often the report is to be generated. It's also possible to run the subscription manually.

Subscriptions tab display:

{|
|-
| width="125px" | '''Name'''
| Shows the name of the subscription.
|-
| '''Delivery method'''
| Shows delivering method for the subscription.
|-
| '''Last started'''
| Shows date and time when the subscription last started.
|-
| '''Last started by'''
| Shows the username of who last started the subscription. Is "schedule" shown the subscription was last started by one of the schedules.
|-
| '''Created by'''
| Shows the username of the creator.
|-
| '''Duration'''
| Displays how long it took to generate all reports and send all e-mails.
|-
| '''Next start time'''
| Shows the next start time from subscription schedules.
|-
| '''Enabled'''
| Shows if the subscription is active, see below on how to - disable/enable a subscription.
|-
| '''Run'''
| [[Image:Icon Run.png]] shows if the subscription is ready to run and [[Image:Icon Cancel.png]] shows if the subscription is already running.
|}

If you want to stop a subscription, there are different ways to do it depending on what you want to achieve. If it's temporary, you can either disable the subscription totally or disable one or more of the subscription schedules. If it's permanent, you can delete the whole subscription.

To stop a running subscription, click [[Image:Icon Cancel.png]].

'''Note:''' Subscriptions marked in red are updated with new or removed settings, to activate the subscription again open subscription and press save.

=== How to - Show Scheduled Report Subscriptions ===

# Click the [[{{Link}}ApplikationAdmin Default|role Application Maintenance]]
# Click '''Push email settings > Scheduled reports'''
#:* A list of all scheduled reports is shown
# Click on the report you want to show/edit subscriptions for

=== How to - Add a New Subscription ===

# Click '''add''' [[Image:Icon Add.png]]
# Select which [[{{Link}}Main_Group|main group]] the scheduled report should belong to
#:* The setting '''belongs to main group''' defines who can see this scheduled report both what main groups the user have directly and what main groups the billing groups the user have rights on belongs to
# Define a '''name''' for the subscription
# Enter a '''description''', i.e. a more detailed information of what the subscription is used for, who it is for etc.
# In the '''delivery method''' menu, select how the report should be accessed
#:* ''Email'' - an email is sent to defined receivers notifying them of that there is a new report, or with the report as an attachment (depending on the '''include report''' setting)
#:* ''Windows file share'' - the report is stored on the server
# Check the '''send to selected persons''' box to select receivers by report selection person, parameters for email to, cc, bcc will be removed
#:* ''Only available on report personal communication cost''
# Check the '''active''' box to activate the subscription
#:* '''Note:''' If the active box is unchecked you are still able to send the scheduled report manually
# Check the '''advanced''' box to use a [[{{Link}}Stored Procedure|stored procedure]] to define any of the parameters:
## Select the correct '''stored procedure''' in the menu
##:* Which stored procedures are shown is defined by database settings
## Check the corresponding box
##:* Only check the box for the parameters that you want the stored procedures to define, the rest can be defined manually
## Select the '''column''' you want to use in the menu
# If you want to set all or some of the subscription settings manually:
#:* The subscription settings are different depending on whether you have selected ''email'' or ''Windows file share'', continue with the corresponding section below

=== How to - Set Up an Email Subscription ===

# Enter the email address to the receiver in the '''to''' field
#:* If there are more than one receiver, enter the addresses separated by semicolons
# If you want to send a copy of the email to another receiver, enter that email address in the '''cc''' field
#:* If there are more than one receiver, enter the addresses separated by semicolons
# If you want to send a copy of the email to a receiver that you don't want to be shown to the other receivers, enter that email address in the '''bcc''' field
#:* If there are more than one receiver, enter the addresses separated by semicolons
# Enter a '''subject''' for the email
# Enter a '''message''' text to be shown in the email
# In the '''include report''' menu, select if the report should be included in the email
#:* ''Yes'' - the report is included in the email as an attachment
#:* ''No'' - the receiver is notified that there is a new report by an email which contains a link to where the report can be accessed
# Select the report '''format'''; ''PDF'' or ''Excel''
# The '''file name''' for the generated report will be the default file name, if not using the stored procedure to set the file name
# Define the '''path''' where the report is to be placed, temporarily if emailing the reports or permanently if the report is not included in the email
# Define the report selection according to the information for that specific report
# Click '''save'''
# If you want these emails to be sent out regularly, click the tab [[{{Link}}Agent PushReportSchedules|schedules]] to set up a schedule

=== How to - Set Up a Windows File Share Subscription ===

# Select the report '''format'''; ''PDF'' or ''Excel''
# Define the '''file name''' for the generated report
# Define the '''path''' where the report is to be placed when using the file share function
# Define the report selection according to the information for that specific report
# Click '''save'''
# If you want this report to be generated regularly, click the tab [[{{Link}}Agent PushReportSchedules|schedules]] to set up a schedule

=== How to - Edit an Existing Subscription ===

# Click on the name of the subscription you want to edit
#:* The ''Edit subscription'' view is displayed
# Edit the necessary properties
#:* For details on the settings, see the '''add a new subscription''' section above
# Click '''save'''

=== How to - Disable/Enable a Subscription ===

# Click on the name of the subscription you want to disable/enable
# Change the '''enabled''' setting for the subscription
#:* To ''enable'' - ensure that the box is checked
#:* To ''disable'' - ensure that the box is '''not''' checked
# Click '''save'''

=== How to - Delete a Subscription ===

# Check the box for each subscription you want to delete
# Click the icon [[Image:Icon Links.png]] to open the action menu in the toolbar above the table, and select delete
#:* The subscription is immediately deleted

=== How to - Run a Subscription Manually ===

# Click '''run''' [[Image:Icon Run.png]] for the subscription you want to run instantly (the report will be generated and sent out by email or placed on the server according to the subscription settings)
#:* Click '''cancel''' [[Image:Icon Cancel.png]] if you like to cancel your scheduled report
#::: '''Note:''' To cancel a scheduled report is only possible in the first part of the process and the icon [[Image:Icon Alarm Status Not OK.png]] is shown when the subscription has been cancelled

=== How to - Create or Edit the Schedules of the Subscriptions ===

# To edit the schedules of how often the report is to be generated, click the [[{{Link}}Agent PushReportSchedules|schedules]] tab

=== How to - Check Subscription History ===

# To check the subscription history, click the [[{{Link}}Agent PushReportHistory|History]] tab

=== How to - Send E-mail to Subscription Recipients ===

# Check the box for each subscription you want to send a message to, based on subscription recipients
#:* All recipients from the subscription will receive the email
# Click the icon [[Image:Icon Links.png]] to open the action menu in the toolbar above the table, and select send e-mail to recipients
#:* The view send e-mail to recipient opens
# Enter a subject and a message or '''load from subscription'''
# Click '''send'''

=== How to - Check Send E-mail to Subscription Recipients History ===

# To check the history for '''Send E-mail to Subscription Recipients''', click the [[{{Link}}Agent PushReportHistory|History]] tab

'''Note:''' History about ''Send E-mail to Subscription Recipients'' is only updated in the e-mail section on the History tab

</translate>

[[Category:F01{{Langcat|Agent PushReportSubscriptions}}]]