TECH SUPPORT

Custom Tasks

Follow

 

With General Tasks, you can perform basic tasks such as printing documents, waiting, or executing other schedules.

 

These tasks are quite powerful. If you are unfamiliar with your system, contact your system administrator prior to creating these tasks. Many of these tasks' functions cannot be undone. This guide is details each custom task available in CSSWeb. Not all tasks in CRD are available in the web product.

 

Custom tasks can be executed as a part of a report schedule, or stand alone in an Automation Schedule.

 

For any task you can click on the options tab to change execution settings.

 

image164.jpg

 

 

If you are executing this task with a report schedule, you have the option of triggering the task before or after the schedule.

 

If executing after the report schedule, you have two options:

 

After successful Report Delivery: Trigger task after the schedule has run and delivered the report to a destination.

 

After Successful Report Production: Trigger task after the report has been produced, prior to delivery.

 

 

General Tasks

image162.jpg

 

Run a Program

 

image163.jpg

 

Use this task to open a document or run a program or batch file.

 

Task Name:  Enter a name for the task

 

Program/Document Path:  Browse to find the path of the program or document

 

Optional Parameter:  Enter any arguments or parameters

 

Windows Style:  Choose from Normal, Minimized, Maximized or Hidden.

 

You can further instruct CSSWeb to wait for the program to exit or to stop waiting for the program after a specified amount of time.

 

Print Document

 

image165.jpg

 

Use this task to print documents to a specified printer.

 

Enter the full path of the file that needs printing.

 

Task Name:  Enter a name for the task

Printer Name:  Select a printer or print driver from the list.

 

Wait / Pause

 

image166.jpg

 

Use this task to create pauses between tasks to ensure that one task is fully complete before the next task in the list is started.

 

 

Task Name:  Enter a name for the task.

 

Select the pause interval to suit your requirements.

 

Send SMS

 

image167.jpg

 

You can send SMS messages using this task. You will need to make sure your SMS messaging configuration in Options is functional.

 

Files and Folders

 

image168.jpg

 

Copy File

 

image169.jpg

 

Use this task to copy one or more files from one location to another.

 

Task Name:  Enter a name for the task

 

Type the full path to the file that needs to be copied.

 

Click the green arrow to drop the file into the list. Continue to add multiple files.

 

Destination Folder: type the full path to the machine where the file will be copied to.

 

Check the checkbox to "Replace existing files at destination".

 

Rename / Move File

 

image170.jpg

 

Use this task to move a file.  Keep the old name, or rename it by simply typing in a new name.  Check to overwrite existing.

 

Delete File

 

image171.jpg

 

Simply browse for the file(s) you wish to delete and add them to the list.

 

 

Write Text File

 

image172.jpg

 

Use this task to create or write to existing text files, or append information and create your own log file.

 

Use Inserts to insert constants or database values.  

 

Create Folder

 

image173.jpg

 

Use this task to create a new folder.  Simply type the path to the parent folder, and then tell CRD what the new folder name should be.

 

Rename / Move Folder

 

New Name: Provide the name of the folder.

 

 

You can use this task to rename or move the folder. Select which action you want to take from the options.

 

Select Folder: Select the folder you want to take the action on.

 

Zip Files

 

image174.jpg image175.jpg

 

 

 

 

You can use this task to zip files. If you need to zip single files from multiple locations you can use the "Simple" view. If you need to zip files in the same folder you can use the Advanced view shown above.

 

 

Files: Specify a path including wildcards e.g. *.*  to select all files.

 

Recursive: This will search the folder and all subfolders.

 

Maintain Folder Structure: Select this to ensure files of the same name are not overwritten and have the folder structure maintained. This is useful when using wildcards.

 

Unzip File

 

image176.jpg

 

This task can be used to unzip a selected zip file to a specified folder.

 

Merge PDF Files

 

image177.jpg image178.jpg

 

*Hint: This task is not to be confused with merging multiple reports in a package schedule.

 

Use this task to merge PDF files. You can select individual PDF files or a folder containing multiple PDF files.

 

Destination File: Select a destination file that the merged file will be saved to.

 

Check the checkbox to replace any existing files at the destination.

 

Merge all files in a single folder: Select a folder, and all PDF files inside the folder will be merged.

 

Build Excel workbook

 

With this option, you can create an excel file directly from a datasource.

image179.jpg

 

 

Click Add to add a dataset.

 

image180.jpg

 

Use the Query Tool to pull the data from your datasource. Select Parse to review your query results.

 

image181.jpg

 

Merge Excel

 

*Hint: This task is not to be confused with merging multiple reports in a package schedule.

 

 

image182.jpg

 

With this task, you can merge multiple Excel files into a single workbook.

 

Simply add files by typing the path.

 

Indicate the folder destination as well.

 

Check this box to Replace existing files at destination.

 

 

Internet Tasks

 

image186.jpg

 

Send an Email

 

image183.jpg

 

Choose from:

 

MAPI (Outlook) address book (Only available if you are using MAPI):  Select one or more email addresses or groups.

 

Or simply type in the email address

 

Subject:  Enter a subject.  Or right-click and select "Insert" to insert constants, database values and defaults.

 

Attach:  Click to select an attachment.  Or right-click and select "Insert" to insert constants, database values and defaults.

 

Body:  Type in your email. Or right-click and select "Insert" to insert constants, database values and email defaults.

 

Mail Format:  Choose from HTML or Text.  When using html, you can enter html tags e.g.

 

<p>pick up the report from

<a href="http://mycompany.com/my%20folder/my%20report">http://mycompany.com/my

folder/my report</a>.

</p>

 

When using text, links will be interpreted as links by the recipient's email address ONLY if they do not contain spaces.  for example:

 

\\servername\foldername\folder\filename.zip - will be interpreted as a link

\\servername\foldername\folder\file name with spaces - will be malformed, with the link cutting off before the first space. In this instance, use html format and tags to ensure the complete link is interpreted correctly.

 

Database Tasks

 

image187.jpg

 

Execute Script

 

image184.jpg

 

ODBC Datasource Name:  Drop down and select a DSN.  

 

We strongly recommend System DSNs so that the DSN is visible to CRD even when the user associated with the DSN is logged off.

 

All communication to databases (including Access databases) is done through ODBC, so you must setup a system DSN to the database before you can use this facility.

 

When setting up DSNs we recommend (if possible) that you use Windows Authentication (Trusted Connection).  This ensures that your username and password are not required to be stored in CRD (more secure) and overcomes a large number of security restrictions which Windows places on DSNs.   When using Windows Authentication, make sure that the CRD NT service user (or background application service user) has full rights to the database otherwise, though you will connect when you are logged in, automated scheduling will fail if the Service user has not got rights to the database.

 

When setting up a DSN to a SQL server, you must ensure that the "Default Database" setting is set to the database you are connecting to (Windows defaults this to "Master").

 

UserID:  Enter the User ID CRD should use to log on to the database.

 

Password:  Enter the password associated with the above user.

 

Connect:  Click Connect to connect to the Database.

 

Script Location:  Browse to locate the script.

 

Run a Stored Procedure

 

image185.jpg

 

DSN Name:  Drop down and select a DSN.  

  • We strongly recommend System DSNs so that the DSN is visible to CRD even when the user associated with the DSN is logged off.  

  • All communication to databases (including Access databases) is done through ODBC, so you must setup a system DSN to the database before you can use this facility.

  • When setting up DSNs we recommend (if possible) that you use Windows Authentication (Trusted Connection).  This ensures that your username and password are not required to be stored in CRD (more secure) and overcomes a large number of security restrictions which Windows places on DSNs.   When using Windows Authentication, make sure that the CRD NT service user (or background application service user) has full rights to the database otherwise, though you will connect when you are logged in, automated scheduling will fail if the Service user has not got rights to the database.

  • When setting up a DSN to a SQL server, you must ensure that the "Default Database" setting is set to the database you are connecting to (Windows defaults this to "Master").

 

UserID:  Enter the User ID CRD should use to log on to the database.

 

Password:  Enter the password associated with the above user.

 

Connect:  Click Connect to connect to the Database.

 

Select a Stored Procedure from the list and enter any required parameters.  For example, if you would normally run your stored procedure by using the query

 

execute myproc para1 para2 para3

 

then

 

Connect to the database and select "myproc" from the list.

Enter in the parameters box:

 

para1 para2 para3

 

 and click OK.

 

 

 

 

 

 

 

 

 

Comments