Editing Pending Actions
Server Manager Start Administer User-defined Jobs Jobs Create User-defined Job Edit User-defined Job Next Edit Scheduling Next Edit Pending Action
or
Server Manager Start Administer User-defined Jobs Jobs Select Job Edit User-defined Job Edit User-defined Job Next Edit Scheduling Next
Edit Pending Action
You can define which action should be executed for a user-defined job. The following actions are available:
Execute a RedDot Query Language command (RQL)
Launch an external application
Call a URL
RQL Documentation
The latest version of the RQL online documentation is available in the customer area of our Web site.
Administering User-defined Jobs Editing User-defined Jobs
0Server Manager05/2009
1. Configure the following settings:
RedDot Query Language command - Select this option to execute a RedDot Query Language command.
User name/Password - Enter the user name and password of the user under whose account the actions should be carried out. For security reasons, you should select a user with an internal account as this user's password will be stored in the database. This also applies to accounts that were imported from directory services, whose passwords would otherwise not be stored in the database. If the user is logged on at the time of execution, the job will be terminated and an error message is created. This message will be stored in the log file and sent out in an e-mail.
RQL statement - Enter the RQL statement to be executed. Enter only one RQL statement in each box. For an example, see the section below, Example: Sending Task Mails to Users.
External application - Select this option to launch an external application. The physical path must be correct. A UNC path is required in a cluster. If you intend to use a UNC path, you have to enter the application in the same directory for every possible application server. You can add parameters to the path, which are passed on to external applications. For more information, see the Example: Transferring Parameters to an External Application section below.
Path - Enter the path of the external application.
XML for error messages in e-mail notification - Enter the XML code to be used in the error messages sent by e-mail.
Open URL - Select this option to execute a URL. The URL must be available when it is called. This function is useful when calling longer scripts of your own with this URL.
The URL execution result - the Web site - is displayed in the #result# placeholder.
URL - Enter the URL you want to call, starting with http.
Include SSO digest as a parameter in the URL - Select the check box to transfer an SSO digest with the specified URL, too. You can use this function for
authentication with Content Deployer, for example. For more information on the structure of the digest, see the information box below.
The following boxes are displayed:
Parameter name - Enter a parameter name that was defined in the system to which you want to authenticate. This input is mandatory.
User name - Specify a user name. This input is not necessarily required. If nothing is specified, no user name is included in the creation of the digest.
Private Key - Enter a private key that was defined in the system to which you want to authenticate. This input is mandatory.
2. Click OK to confirm or click Next to configure additional settings.
See also:
Editing E-mail Notifications (Page 129)
Administering User-defined Jobs Editing User-defined Jobs
0Server Manager05/2009
Structure of the SSO Digest
You can transmit an SSO digest together with a URL call using the following structure:
Parametername=LoginName|Timestamp|TimeBias|MD5Hash Example:
sso=TestUser|20081027095715|+01:00|
6665F482DA1536FA66B8DED56E1F21C6
The digest comprises several elements, which have to be separated by pipe (|) characters.
Parametername: The parameter name that was entered in the Edit Pending Action dialog window.
LoginName: The user name that was entered in the Edit Pending Action dialog window.
Timestamp: Format: yyyyMMddHHmmss (YearMonthDayHourMinuteSecond). The year is entered as a four-digit number, all other values as two-digit numbers.
Hours are specified in 24-hour format.
Example: 20050829145501 to obtain the time stamp 2005-08-29 14:55:01
TimeBias: Indicates the difference to GMT0. Format:[+/-]HH:mm (SignHour:Minute). Example: +13:00
MD5Hash: Value generated to verify the information, specified in hexadecimal form.
Example: 7C072DE6355A81B976CE9AC32A
The MD5Hash is created from the following elements:
LoginName|Timestamp|TimeBias|Private Key
The Private Key placeholder is replaced by the key that was entered in the Edit Pending Action dialog window.
Administering User-defined Jobs Editing User-defined Jobs
0Server Manager05/2009
Transferring Parameters to an External Application
You can transfer parameters for the external application after entering the path. Enter this as a space. The parameters are transferred in the order in which they are entered.
You can control your external application through freely definable parameters, depending on the programming. This means, for example, that an application can be used for a variety of purposes. Depending on the context, the application can then be addressed with various parameters and therefore perform a variety of actions.
Defined Parameter %LOG%
The parameter %LOG% transfers the path and file name of the configuration file of the publication job if the user-defined job was automatically started after a publication.
This setting can be made in SmartTree (Administer Publication -> Project -> Start User-defined Job). The configuration file also contains the path to the publication log files. This can be used by the external application, for example to read log files and therefore determine the file names of the published files.
Example: Sending Task Mails to Users
User-defined jobs let you automatically notify users by e-mail of the tasks waiting for them in the project (these are tasks in the content workflow). Enter the following RQL statement:
<IODATA loginguid="[!guid_login!]">
<ADMINISTRATION action="validate" guid="[!guid_login!]">
<PROJECT guid="[!guid_project!]"/>
</ADMINISTRATION>
Customize the statement as follows:
1. In the guid attribute of the <PROJECT> element, and in the projectguid attribute of the <TASKMAIL> element, enter the project GUID of the project you require.
To find the project GUID, go to Administer Projects in the Server Manager and select a project. Then click the symbol in the top right-hand corner of the Action Menu to open the information section.
2. In the guid attribute of the <USER> element, enter the user GUID of the user to receive the task mails.
To find the user GUID, follow the same steps as for the project GUID.
Administering User-defined Jobs Editing User-defined Jobs
0Server Manager05/2009
To send task mails to additional users, add more <USER> elements with the respective user GUIDs.
To send task mails to all users of a project, add the users="all" attribute to the <TASKMAIL> element. In this case, you do not need to include the <USERS>
... </USERS> section or the closing </TASKMAIL> tag.
You can also run a user search to identify the user to whom you wish to send task mails. To determine the appropriate RQL statement, open the Server Manager and run a user search (under Administer Users and Groups -> Users -> Edit User). The RQL statement for the search query will be recorded in the Common log file.
Example:
<USERS action="search">
<SEARCHITEMS>
<SEARCHITEM key="name" value="a*" operator="like" />
<SEARCHITEM key="fullname" value="a*" operator="like" />
<SEARCHITEM key="description" value="a*" operator="like" />
<SEARCHITEM key="email" value="a*" operator="like" />
</SEARCHITEMS>
</USERS>
In this example, task e-mails are sent to all users who are assigned to the project and whose user names, full names, e-mail addresses, and descriptions start with the letter a.
3. Click OK to confirm, or click Next to configure additional settings.
User-defined Jobs - RQL
User-defined jobs may only have the same user if they are not scheduled to be executed simultaneously. One user cannot execute several user-defined jobs simultaneously. We therefore recommend creating a user specifically for user-defined jobs. This user must be authorized to execute the functions contained in the RQL statement, which means that he or she must have the appropriate roles and authorizations.
User-defined Jobs
One example of a user-defined job is a user-defined project export. You use this type of user-defined job to back up your projects.
Administering User-defined Jobs Editing User-defined Jobs
0Server Manager05/2009