To-Do Types

Calculate Support Costs: Type = 0

Executes the same function as the Calculate option in the Support info area.

Parameters:

• <FI_StaNo>-<FI_SerNo> (e.g. 100-12) (leave empty for all companies)
• Start year (integer, 4 digits)
• End year (integer, 4 digits)
• Currency (catalog code); optional; the base currency is used by default

Calculate Campaign Status: Type = 1

Executes the same function as the Calculate option in the Campaign info area.

Parameters:

• <CM_StaNo>-<CM_SerNo> (e.g. 10-47) (leave empty for all campaigns)

Calculate Activity Status: Type = 2

Executes the same function as the Calculate option in the Marketing Activity info area.

Parameters:

• <AK_StaNo>-<AK_SerNo> (e.g. 1-57)

Fill Telephone Number Table: Type = 3

Executes the same function as the Fill option in the Tel.No./E-mail info area (no parameters).

Inventory: Type = 4

Executes the same function as the Stocktaking option in the Stock info area, see Stocktaking in the Business Logic Manual.

4 ;20121005 ;20121020;text;10000003

Parameters:

• ID of the stocktaking format
• Start date (integer, 8-digit, yyyymmdd)
• End date (integer, 8-digit, yyyymmdd)
• Stocktaking text (max. 100 characters)
• Rep ID (ID of the rep for whom the stocktaking should be executed)

  Specifying a Rep ID in the to-do overrules the rep selection in the stocktaking format (Employee list on the General tab).

Allocate Business Line: Type = 5 (OTC only)

Executes the same function as the Allocate option in the Business Line info area (no parameters).

Execute Query: Type = 7

Executes a query in Aurea CRM web, see Background Queries in the Aurea CRM web Administrator Guide. The query result is either saved in a query result record (Q1) or written to a file.

Parameters (all optional):

• -n: name of the query result (if no name is specified, the following name is assigned: <query_name>_<creation_date>_<creation_time>)
• -r: maximum number of result lines (if not specified, no restrictions apply)
• -f: private (>0 = private, otherwise global)
• -csv: the query results are written to a file

The query format is saved as a document in the database (D1 table) and linked to the To-Do by means of a document link. The document contains the XML definition of the query. After successfully executing the query, the document is deleted from the database.

XML Report: Type = 9

Creates an XML report, see Reports in the Aurea CRM win User Manual.

Parameters:

• -xml <report name>
• -xfile <Path> (path to a file containing a report name per line)
• save=1;context=1;doc.class=<text>;keyword=<text>

  Use these parameters to specify how the report should be saved in Aurea CRM's database.

  • save=1 ... The report document is saved to the Document info area (D1) under the name specified in the report format. (save=0 (default) ... The report is not saved in the database but created as specified in the Report format).
  • context=1 ... The D1 record is linked to the record entered in the Link field in the To-Do record via a Document link record (D3).

    If the Context of the report format is set to "current record", the linked record is used as context for the report.

    This parameter is ignored when used in the command line.

  • <doc.class> is a text parameter: You can enter the external key of the catalog value that is added to the new D1 record (Document class field).
  • <keyword> is a text parameter: You can add a value (for example the customer's ID) that is added to the new D1 record (Keyword field).

  The four parameters must be separated by semicolons.

  If the record entered in the Link field is already linked to a D1 record with the document and the same Document class catalog value via D3 record, the document is replaced by the new report and no new records are created. If the D1 record contains a document with a different name than specified in the Report format, the document's name is left unchanged and updated with the contents of the report. If there's a different Document class entered, a new link is created in addition to the already existing one.

Prerequisites:

• The report format must be present in Aurea CRM.
• The path and file name of the report (defined under Select File/Directory in the Define Report Format window; or under Save first transformation to file) must be defined.
• The report may not use any variable conditions.

If these prerequisites are not met, the process is aborted.

Calculate Accommodation & Event Venue Ratings: Type = 10

Calculates the average of all event ratings (accommodation and venue).

Parameters:

• Start date of the campaign (format: YYYYMMDD). All campaigns that start after the specified date are calculated. If no start date is specified, the average is calculated for all campaigns.

Calculate Lecture & Speaker Ratings: Type = 11

Calculates the average of all event ratings (lecture and speaker).

Parameters:

• Start date of the agenda item (format: YYYYMMDD). All agenda items that start after the specified date are calculated. If no start date is specified, the average is calculated for all campaigns and agenda items.

Update Sales Territory Management: Type = 12 (BTB and FS only)

Updates the allocation of reps (in sales groups and property management records) for companies, persons and properties (BTB only), see Territory Management in the Business Logic Manuals.

Enter the To-do type and affected info areas in the Text field :

12;FI,KP,OJ updates the allocation for all three info areas,

12;KP only updates the allocation to persons in the Person in Company info area.

Mass Updates: Type = 14

Applies mass data updates for Aurea CRM web, see Mass Data Operations in the Aurea CRM web Administrator Guide.

Parameters:

• Abbreviation of the info area subject to the change (e.g. "FI")
• The frequency with which the To-Do is executed (between the due date and end date). Format: 3d = 3 days, 2m = 2 months. This parameter is optional.

If errors occur, a log file is saved in the database and linked to the appropriate message. If the web URL configuration entry is present, the file also contains a link to the Aurea CRM web record that the error affects.

Mass Deletions: Type = 15

Mass Deletions without Communication: Type = 16

Carries out mass deletions for Aurea CRM web, see Mass Data Operations in the Aurea CRM web Administrator Guide.

Parameters:

• Abbreviation of the info area subject to the change (e.g. "FI")
• The frequency with which the To-Do is executed (between the due date and end date). Format: 3d = 3 days, 2m = 2 months. This parameter is optional.

If errors occur, a log file is saved in the database and linked to the appropriate message. If the web URL configuration entry is present, the file also contains a link to the Aurea CRM web record that the error affects.

Create Calendar Definition Entries: Type = 17

Creates records in the Calendar Definition (CD) info area for the specified time span and calendar IDs, see Calendar Definition Info Area.

17 ;YYYY -MM-DD,YYYY-MM-DD,ID1,ID2,...

Parameters:

• Start / End Dates (format YYYY-MM-DD or YYYYMMDD): The records are created the specified time span. The maximum number of days and therefore records is 3660. If the time span exceeds this number, no records are created.
• Calendar ID(s): Catalog value IDs of the fixed catalog "Calendar". If no value exists for the specified ID, no records are created.

Calculate Root Ticket for Existing Ticket Hierarchy: Type = 18

Enters a link to the respective root ticket in all existing (hierarchical) tickets (KM_2_StaNo/SerNo/Link). (This is required to highlight all Activity records belonging to a ticket hierarchy in the Dispatching Dashboard.)

18 ;KM

Alternatively, you can use the Generate Root ID context menu option in the Ticket Overview (in Aurea CRM win).

Calculate Corporate Structures: Type = 19

Generates/updates relationship levels for corporate structures in Aurea CRM web, see Corporate Structures in the Business Logic Manual.

19 ;force ;highLevelUpdate;timestamp

Parameters (optional):

• force : By default, corporate structures are only created, if at least one relationship hierarchy entry is present in the Relationship level (BL) info area. Use the force parameter to create corporate structures even if no relationship hierarchy exists.
• highLevelUpdate : By default, no triggers are executed when this to-do changes records. Use the highLevelUpdate parameter to enable the execution of triggers.
• timestamp : By default, no time stamps are set in the relationship records when this to-do changes records. Use the timestamp to enable the setting of time stamps.

The calculation is tracked in the Process Tracking (T3) info area (process "Generate Relationship Hierarchy" (1010)). Relationship records with no children are deleted during this process. Relationships with a depth greater than 10 levels and relationship loops are written to the log file.

Calculate Item Structures: Type = 20

Generates/updates item structure records (IS), see Item Structure in the Business Logic Manual.

This to-do type supports the same parameters as described for type 19.

Import: Type = 21

Allows starting an import, see Import/Export in the Aurea CRM win Administrator Guide.

21;import_FI;C:\temp\FI_imp.txt;1

Parameters:

• Name of the import format (required when importing from file and from database)
• Path and name of the import file (only required when importing from file)

  If undefined, the file specified in the import format is used. In this case, you need to add an "empty" parameter, e.g. 21;import_FI;;

• Switch for creating Import Results records (C5): 0 or 1.

  If undefined, the setting specified in the import format is used (Log import results check box in the File Format dialog).

After completion of the to-do the following information is written to the database:

• The message (MD) that is created for the Assigned by rep contains the number of records that have been imported successfully and the number of records for which the import failed in the Message field.
• The record ID of the import log record (created in the Communication Log info area C3) is written to the Text field of the message record (e.g. "#71/x0000000000000001").

For imports which should be executed at regular intervals you can define jobs of type ImportJob in the settings.server.xml, see Scheduling Import Jobs.

Export: Type = 22

Allows starting an export, see Import/Export in the Aurea CRM win Administrator Guide.

22;export_PR;C:\temp\PR_export.txt

Parameters:

• Name of the format
• Path and name of the target file

  If undefined, the file specified in the format is used. In this case, you need to add an "empty" parameter, e.g. 21;export_PR;;

For exports which should be executed at regular intervals you can define jobs of type ExportJob in the settings.server.xml, see Scheduling Export Jobs.