Enterprise Edition:Subscription-Assistant: Difference between revisions
From CoPlanner 10
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (16 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
The subscription assistant helps you to create and edit | The subscription assistant helps you to create and edit subscriptions. | ||
In the following example you create a new subscription, which sends the report "Cockpit Comparison" monthly per e-mail as pdf-file. | In the following example you create a new subscription, which sends the report "Cockpit Comparison" monthly per e-mail as pdf-file. | ||
| Line 6: | Line 6: | ||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">'''Input'''</span> Activate element „Jobs“ and select the command „New subscription“ from the | |<span style="color: darkblue">'''Input'''</span> Activate element „Jobs“ and select the command „New subscription“ from the context menu.'' | ||
|} | |} | ||
The Subscription-Assistant opens: | The Subscription-Assistant opens: | ||
| Line 27: | Line 19: | ||
*Parameter | *Parameter | ||
*Receiver | *Receiver | ||
==General== | ==General== | ||
In this area you define the name of the subscription and the login information, select the report server and the output format. | In this area you define the name of the subscription and the login information, select the report server and the output format. | ||
===Name of the subscription=== | ===Name of the subscription=== | ||
This field allows you anytime to change the name of the subscription. | This field allows you anytime to change the name of the subscription. | ||
{| {{Bausteindesign2}} | |||
|- | |||
|<span style="color: darkblue">'''Input'''</span> Enter the caption „Cockpit Comparison“ and confirm with „OK“.'' | |||
|} | |||
===Login information=== | ===Login information=== | ||
| Line 43: | Line 43: | ||
===Report Server=== | ===Report Server=== | ||
Here you can enter | Here you can enter your report server. Automatically all available reports are shown below. | ||
| Line 74: | Line 74: | ||
You have two possibilities to deliver: | You have two possibilities to deliver: | ||
*File sharing<br> | *File sharing<br>Use Report Server File Share to deliver a report to a location on the file system. You can deliver any report to a file share. | ||
*E-mail<br>Deliver a report as e-mail | *E-mail<br>Deliver a report as e-mail attachment. | ||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
| Line 88: | Line 89: | ||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">'''Input'''</span> Click this button to add a subject and a | |<span style="color: darkblue">'''Input'''</span> Click this button to add a subject and a message to the e-mail.'' | ||
|} | |} | ||
| Line 96: | Line 97: | ||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">'''Input'''</span> | |<span style="color: darkblue">'''Input'''</span> Insert following text in the row "Subject": CoPlanner Report 'Cockpit Comparison' | ||
Confirm with „OK“.'' | |||
|} | |} | ||
| Line 103: | Line 104: | ||
{| {{Bausteindesign1}} | {| {{Bausteindesign1}} | ||
|- | |- | ||
| <span style="color: darkblue;">''' | | <span style="color: darkblue;">'''Hint'''</span> Initially there will be no subject and message. | ||
|} | |} | ||
=== | ===State=== | ||
Use this option to activate the subscription or deactivate it. | |||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">''' | |<span style="color: darkblue">'''Input'''</span> Activate the option "active" and choose the area „Schedule“.'' | ||
|} | |} | ||
== | ==Schedule== | ||
Use this schedule to determine how often this report is delivered. | |||
[[Image:EE_AM-Assistent02.jpg|thumb|center|Enterprise Edition, | [[Image:EE_AM-Assistent02.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Schedule]] | ||
=== | ===Schedule details=== | ||
Select options that determine when and how often a report runs. Frequency options are layered. The first set of options specifies a category of frequency (hourly, daily, weekly, and so on). The second set of options that appears is based on your initial selection. | |||
Select Daily to define a schedule that runs on the days you select at a specific hour and minute. You can specify days in the following ways: Every <day>, Every weekday, and Every <number> day. Choosing one approach voids the others, even if the other days appear to be selected. | |||
[[Image:EE_AM-AssistentZeitplan01.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Daily]] | |||
Select Weekly to define a schedule that runs at weekly intervals at a specific hour and minute. The interval can be a complete week (for example, every two weeks), or days within a week. | |||
[[Image:EE_AM-AssistentZeitplan02.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Weekly ]] | |||
Select Monthly to define a schedule that runs on a monthly basis. Within a month, you can choose a day based on a pattern (for example, the last Sunday of every month) or specific calendar dates (such as 1 and 15 to indicate the first and fifteenth day of every month). Using commas and hyphens, you can specify multiple days and ranges; for example, 1, 5, 7-12, 21. | |||
[[Image:EE_AM-AssistentZeitplan03.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Monthly ]] | |||
===Start and end dates=== | |||
Specify a start date that determines when the schedule takes effect and an end date that determines when the schedule expires. | |||
Schedules expire without notification. After the end date, they no longer run. Expired schedules are not deleted. Schedules can only be deleted manually. That way, if you choose to continue the schedule, you can extend the end date. | |||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">''' | |<span style="color: darkblue">'''Input'''</span> Activate the option „Monthly“ and select all months. Afterwards choose „On week of month“ 1. and „On day of week“ Tue. | ||
Activate „Parameter“.'' | |||
|} | |} | ||
== | ==Parameter== | ||
Specify the report parameter values to use with this subscription. You can define parameter values for all user or individual for each user, as well as a combination of global and individual parameter values. | |||
[[Image:EE_AM-Assistent03.jpg|thumb|center|Enterprise Edition, | [[Image:EE_AM-Assistent03.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Parameter]] | ||
Following options are available for each parameter value: | |||
* | *Insert an expression:<br>Possible expressions are [[:Category:Functions_-_server-side|CoPlanner functions]], [[Framework:Session_variables|Session variables]] and [[Framework:Application_Properties|Application Properties]]. E. g. type FKT_GetDate(COPDATEMONTH), to select the actual month. | ||
* | *Insert a selection:<br>Select an element. | ||
* | *According to the User Administration<br> | ||
* | *For each user individual<br> | ||
<br> | <br> | ||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">''' | |<span style="color: darkblue">'''Input'''</span> Choose following parameter values:<br> | ||
Period: FKT_GetDate(COPDATEMONTH)<br> | |||
Forecast: Forecast 2010<br> | Forecast: Forecast 2010<br> | ||
Plan: Plan 2010<br> | Plan: Plan 2010<br> | ||
Company: Bike GmbH<br> | |||
Activate receiver'' | |||
|} | |} | ||
== | ==Receiver== | ||
Specify the user to this subscription. | |||
[[Image:EE_AM-Assistent04.jpg|thumb|center|Enterprise Edition, | [[Image:EE_AM-Assistent04.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Receiver]] | ||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">''' | |<span style="color: darkblue">'''Input'''</span> Select a user and type the e-mail address.<br> | ||
Finish the Subscription-Assistant with „Apply“'' | |||
|} | |} | ||
| Line 187: | Line 190: | ||
{| {{Bausteindesign1}} | {| {{Bausteindesign1}} | ||
|- | |- | ||
| <span style="color: darkblue;">''' | | <span style="color: darkblue;">'''Hint'''</span> The settings in Receiver/Parameter are related to each single user. | ||
|} | |} | ||
If you choose the filter setting „For each user individual“ in the area „Parameter“, this parameter will be green in this control. | |||
[[Image:EE_AM-AssistentIndividParam.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Individual parameter value]] | |||
[[Image:EE_AM-AssistentIndividParam.jpg|thumb|center|Enterprise Edition, | |||
If you choose „File sharing“ in „General“, „Path“ will be shown in this section. | |||
[[Image:EE_AM-AssistentDateifreigabe.jpg|thumb|center|Enterprise Edition, | [[Image:EE_AM-AssistentDateifreigabe.jpg|thumb|center|Enterprise Edition, Subscription-Assistant, Path]] | ||
{| {{Bausteindesign1}} | {| {{Bausteindesign1}} | ||
|- | |- | ||
| <span style="color: darkblue;">''' | | <span style="color: darkblue;">'''Hint'''</span> The file share must be specified in Uniform Naming Convention (UNC) format (for example, \\myserver\myreportfiles). Do not include a trailing backslash in the path name. | ||
|} | |} | ||
| Line 208: | Line 210: | ||
{| {{Bausteindesign2}} | {| {{Bausteindesign2}} | ||
|- | |- | ||
|<span style="color: darkblue">''' | |<span style="color: darkblue">'''Input'''</span> Test the new subscription with the button „Execute“ [[Image:Icon Execute.png]].'' | ||
|} | |} | ||
| Line 216: | Line 218: | ||
[[Category:Enterprise_Edition|Subscription-Assistant]] | [[Category:Enterprise_Edition|Subscription-Assistant]] | ||
[[Category:Subscriptions|Subscription-Assistant]] | [[Category:Subscriptions|Subscription-Assistant]] | ||
[[Category:User interface|Subscription-Assistant]] | |||
[[de:Enterprise_Edition:Abonnement-Assistent]] | |||
Latest revision as of 16:35, 24 November 2010
The subscription assistant helps you to create and edit subscriptions.
In the following example you create a new subscription, which sends the report "Cockpit Comparison" monthly per e-mail as pdf-file.
| Input Activate element „Jobs“ and select the command „New subscription“ from the context menu. |
The Subscription-Assistant opens:
The Subscription Assistant contains four areas:
- General
- Schedule
- Parameter
- Receiver
General
In this area you define the name of the subscription and the login information, select the report server and the output format.
Name of the subscription
This field allows you anytime to change the name of the subscription.
| Input Enter the caption „Cockpit Comparison“ and confirm with „OK“. |
Login information
You define here, how the Subscription Manager logged on the CoPlanner server. Therefore you are able to select different languages for the same report. Additionally you have the advantage of the definition of the current scenario and company, because of when inserting "Current scenario" as report parameter you have to change only the login information later and not the report parameter.
Report Server
Here you can enter your report server. Automatically all available reports are shown below.
| Input Select the report „MID Übersicht Standard VGL“ from the combo box. |
Notify user
Here you define the export format and the kind of delivery. The “Export to file” option supports the following formats:
- XML file with report data
- CSV (comma-separated file)
- Acrobat file (PDF)
- MHTML (Web archive)
- Excel
- TIFF-File
- Word
| Hint The available render formats depend on the version and configuration of your report server. |
| Input Choose render format „Acrobat file (PDF)“. |
You have two possibilities to deliver:
- File sharing
Use Report Server File Share to deliver a report to a location on the file system. You can deliver any report to a file share. - E-mail
Deliver a report as e-mail attachment.
| Input Choose „E-Mail“. |
Automatically a button is shown beside the combo box.
| Input Click this button to add a subject and a message to the e-mail. |
| Input Insert following text in the row "Subject": CoPlanner Report 'Cockpit Comparison'
Confirm with „OK“. |
| Hint Initially there will be no subject and message. |
State
Use this option to activate the subscription or deactivate it.
| Input Activate the option "active" and choose the area „Schedule“. |
Schedule
Use this schedule to determine how often this report is delivered.
Schedule details
Select options that determine when and how often a report runs. Frequency options are layered. The first set of options specifies a category of frequency (hourly, daily, weekly, and so on). The second set of options that appears is based on your initial selection.
Select Daily to define a schedule that runs on the days you select at a specific hour and minute. You can specify days in the following ways: Every <day>, Every weekday, and Every <number> day. Choosing one approach voids the others, even if the other days appear to be selected.
Select Weekly to define a schedule that runs at weekly intervals at a specific hour and minute. The interval can be a complete week (for example, every two weeks), or days within a week.
Select Monthly to define a schedule that runs on a monthly basis. Within a month, you can choose a day based on a pattern (for example, the last Sunday of every month) or specific calendar dates (such as 1 and 15 to indicate the first and fifteenth day of every month). Using commas and hyphens, you can specify multiple days and ranges; for example, 1, 5, 7-12, 21.
Start and end dates
Specify a start date that determines when the schedule takes effect and an end date that determines when the schedule expires.
Schedules expire without notification. After the end date, they no longer run. Expired schedules are not deleted. Schedules can only be deleted manually. That way, if you choose to continue the schedule, you can extend the end date.
| Input Activate the option „Monthly“ and select all months. Afterwards choose „On week of month“ 1. and „On day of week“ Tue.
Activate „Parameter“. |
Parameter
Specify the report parameter values to use with this subscription. You can define parameter values for all user or individual for each user, as well as a combination of global and individual parameter values.
Following options are available for each parameter value:
- Insert an expression:
Possible expressions are CoPlanner functions, Session variables and Application Properties. E. g. type FKT_GetDate(COPDATEMONTH), to select the actual month. - Insert a selection:
Select an element. - According to the User Administration
- For each user individual
| Input Choose following parameter values: Period: FKT_GetDate(COPDATEMONTH) |
Receiver
Specify the user to this subscription.
| Input Select a user and type the e-mail address. Finish the Subscription-Assistant with „Apply“ |
| Hint The settings in Receiver/Parameter are related to each single user. |
If you choose the filter setting „For each user individual“ in the area „Parameter“, this parameter will be green in this control.
If you choose „File sharing“ in „General“, „Path“ will be shown in this section.
| Hint The file share must be specified in Uniform Naming Convention (UNC) format (for example, \\myserver\myreportfiles). Do not include a trailing backslash in the path name. |
Input Test the new subscription with the button „Execute“  .
|
