Custom attributes displayed on email notifications

MoroccoDCTM

Hi all,

Our client requires that some additional attributes to be displayed on the quickflow notification email.

I tried to modify dm_event_sender.ebs but I can't display custom attributes (or any additional attribute).

Please, can you help me with this requirement?

Thank you in advance.

Find more posts tagged with

Comments

DCTM_Guru

Please post your code. Did you query for your custom attribute? Its not going to magically be available using out of the box code.

MoroccoDCTM

Hi Johnny,

Thank you for your quick response.

Actually I will be grateful if you have an exemple on how I can query the needed attributes.

My code is not very different, I just replaced one of the attributes with a custom one, but as you said, it didn't work.

DCTM_Guru

I dont have code on hand. Just post what you have done so far and the community should be able to help you out.

MoroccoDCTM

Here is the code:

' ===========================================================================
' (c) Copyright Documentum, Inc., 2002
'
' Name : dm_event_sender.ebs
'
' Developer Note: dm_event_sender.ebs and dm_html_sender.ebs are
' interchangeable; make sure that changes are
' reflected in both files.
'
'------------------------------------------------------------
Public subject_note$
Public platform_type$
'------------------------------------------------------------
Sub Version()
print "version Documentum SendEvent docbasic: v1.1"
End Sub

' Function BuildSingleMessageRecipientList
'
' This function parses the bulk mail file to determine if it is possible to
' the same message to all recipients. For the sake of efficiency, we also build
' the list of recipients from the e-mail as we scan through it. By doing this
' at the same time we can avoid having to parse the e-mail again later.
'
' Returns:
'   True if a single message can be generated for the given bulk mail file, False
'   otherwise.
'
'   When True is returned:
'   - address_list will also contain a valid list of destination addresses for
'     the message.
'   - address_count will contain the number of addresses in address_list
'   - return_stamp and return_package_id will contain the stamp and package ID
'     that should be used to generate the contents of the e-mail
Sub BuildSingleMessageRecipientList (_
    bulk_mail_file As String,_
    address_list() As String,_
    ByRef result as Boolean,_
    ByRef address_count As Integer,_
    ByRef return_stamp As String,_
    ByRef return_package_id As String)

' Variable declarations
Dim address_list_size As Integer
Dim index As Integer
Dim stamp As String
Dim package_id As String

'Print "Bulk file is: '" & bulk_mail_file$ & "'"

Open bulk_mail_file$ For Input Access Read As #3

' Prepare the address list. We start with size 1000 and grow the array
' by an additional 1000 when we run out of space.
Redim address_list$(1000)
address_list_size = 1000
index = 0

' Set stamp and package_id to null
stamp$ = ""
package_id$ = ""

' Assume that we will be able to send a single mail for now
result = True

' Iterate through the entries in the bulk mail file.
Do
    ' Check for EOF here
    If EOF(3) Then
      Exit Do
    End If

    ' Read the line
    Line Input #3, lineInput$

    If Item$(lineInput$, 1, 1, "|") = "" Then
      Exit Do
    End If

    recipient_login_name$ = Item$(lineInput$, 1, 1, "|")
    recipient_name$ = Item$(lineInput$, 2, 2, "|")
    cur_stamp$ = Item$(lineInput$, 3, 3, "|")
    cur_package_id$ = Item$(lineInput$, 4, 4, "|")

    ' If this is the first iteration, set the stamp value. For subsequent iterations,
    ' validate that the stamp is the same.
    If stamp$ = "" Then
      stamp$ = cur_stamp$
    Else
      If stamp$ <> cur_stamp$ Then
        Print "Stamp mismatch! Individual e-mails are required."
        result = False
        Exit Do
      End If
    End If

    ' Now, do the same for package ID.
    If package_id$ = "" Then
      package_id$ = cur_package_id$
    Else
      If package_id$ <> cur_package_id$ Then
        Print "Package ID mismatch! Individual e-mails are required."
        result = False
        Exit Do
      End If
    End If

    'Print recipient_login_name$

    address_list(index) = recipient_name$
    index = index + 1

    ' Grow the address array if necessary
    If index = address_list_size Then
      address_list_size = address_list_size + 1000
      Redim Preserve address_list$(address_list_size)
    End If

Loop While result = True

' close the bulk mail file
Close #3

'Print "result is: " & result

' setup return variables
If result = True Then
    address_count = index
    return_stamp = stamp
    return_package_id = package_id
Else
    address_count = 0
    Redim address_list$(0)
End If

End Sub

'------------------------------------------------------------
'This is the main subroutine of this procedure. It is called
'by a docbase server when it is necessary to email a notification
'of an event or task that has been posted to a docbase user's inbox.
'It is passed raw information pertaining to the event or task,
'constructs a subject line and an email body, then mails the email.
Sub Mail (_
      docbase_name$,_
      due_date$,_
      event_name$,_
      message_text$,_
      object_name$,_      'for mails related to workflow task, this is the runtime state of the task.
      package_id$,_
      planned_start_date$,_
      task_priority$,_
      router_id$,_
      router_name$,_
      sender_name$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      recipient_login_name$,_
      recipient_name$,_
      platform$,_                     '"WIN32" for NT and "undefined" for any other platform.
      mail_user_name$,_       'This argument is used only for sending mail on NT.
      stamp$,_            'object id of dmi_queue_item
      date_sent$,_        'date sent
      link_cnt$,_         'r_link_cnt value of sysobject
      package_type$,_     'package_type of dmi_queue_item
      content_type$,_     'package content_type
      content_size$,_     'r_content_size value of sysobject
      dos_extension$,_    'dos_extension of the the content type
      web_server$,_       'web server location name|web server port name
      web_server_type$,_   'web server type(Explorer or Netscape)
      temp_file_name$,_       'Name of the file with message content.
      mailScript$, _          'Command, used for sending mail.
      bulk_mail_file$,_     ' file with multiple addresses
      smtp_server$)

' Declarations
Dim use_single_message_optimization As Boolean
Dim do_single_message As Boolean
Dim single_message_address_list() As String
Dim single_message_address_count As Integer
Dim single_message_stamp As String
Dim single_message_package_id As String

' Options
'
' Single mail command optimization: set this to "True" to enable sending bulk e-mail
' messages as a single message when possible. This should reduce processing time for
' some bulk e-mails.
' NOTE: This should only be used on HP-UX, AIX, and Solaris systems. Do not use on
' Linux or Windows.
use_single_message_optimization = False

'First check if smtp_server and mail_user_name are passed in correctly.
If platform$ = "WIN32" Then
If Trim$(smtp_server$) = "" or Trim$(mail_user_name$) = "" Then
    Print "dm_event_sender.ebs could not send mail: either smtp_server(" _
          & smtp_server$ & ") or sender(" & mail_user_name$ & ") is not " _
          & "set up correctly."
    dmExit(-1)
End If
End If

' Initialization
platform_type$ = platform$
subject_line$ = " "
object_info_flag$ = "false"
task_event_flag$ = "false"
router_event_flag$ = "false"
print_email_body_flag$ = "false"
do_single_message = False

If router_name$ = "null" Then
      router_name$ = " "
End If

If mgb_raison_sociale$ = "null" Then
      mgb_raison_sociale$ = " "
End If

If task_name$ = "null" Then
      task_name$ = " "
End If

If task_number$ = "null" Then
      task_number$ = " "
End If

If message_text$ = "null" Then
      message_text$ = " "
End If

if planned_start_date$ = "nulldate" then
      planned_start_date$ = "none"
end if

if due_date$ = "nulldate" then
      due_date$ = "none"
end if

'Print "bulk_mail_file$ is " & bulk_mail_file$

If bulk_mail_file$ <> " " Then
   ' check to see if we can send a single message
   If use_single_message_optimization = True Then
     Call BuildSingleMessageRecipientList(bulk_mail_file$, single_message_address_list$,_
         do_single_message, single_message_address_count, single_message_stamp,_
         single_message_package_id)
   End If

   ' if we can't send multiple messages open the bulk mail file for normal processing
   If do_single_message = False Then
     Open bulk_mail_file$ For Input Access Read As #3
   End If
End If

Do
If do_single_message = True Then
    stamp$ = single_message_stamp$
    package_id$ = single_message_package_id$
    recipient_name$ = "Multiple Recipients"
    recipient_login_name = "N/A"
ElseIf bulk_mail_file$ <> " " Then
    If EOF(3) Then
      Exit Do
    End If
    Line Input #3, lineInput$
    If Item$(lineInput$, 1, 1, "|") = "" Then
      Exit Do
    End If
    recipient_login_name$ = Item$(lineInput$, 1, 1, "|")
    recipient_name$ = Item$(lineInput$, 2, 2, "|")
    stamp$ = Item$(lineInput$, 3, 3, "|")
    package_id$ = Item$(lineInput$, 4, 4, "|")

End If

' Print "Processing mail for " & recipient_name$ & _
'        "|" & recipient_login_name$ & "|" & stamp$ & "|" & _
'        package_id$


'Open a file in which to construct the message body:

Open temp_file_name$ For Output Access Write As #2

'Create the subject line and body of the email:

call construct_required_email_parts (_
      temp_file_name$,_
      docbase_name$,_
      event_name$,_
      message_text$,_
      object_name$,_
      router_name$,_
      sender_name$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      recipient_name$,_
      object_info_flag$,_
      task_event_flag$,_
      router_event_flag$,_
      print_email_body_flag$,_
      subject_line$,_
      package_id$,_
      router_id$)

If print_email_body_flag$ = "true" Then
call PrintEmailBody(2,object_name$,package_id$,docbase_name$,subject_note$)
End If

'Append additional info for the user:
'(NOTE: the following calls provide useful ancillary information
' about the current event, but may be commented out if desired.)

call append_object_info (_
      temp_file_name$,_
      object_name$,_
      object_info_flag$)

call append_routing_info (_
      temp_file_name$,_
      docbase_name$,_
      due_date$,_
      event_name$,_
      message_text$,_
      object_name$,_
      package_id$,_
      planned_start_date$,_
      task_priority$,_
      router_id$,_
      router_name$,_
      sender_name$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      recipient_name$,_
      router_event_flag$,_
      task_event_flag$)

'Append server 3.1-style computer-readable info:
'(NOTE: This call appends a computer-readable data
'block in a new, easier to parse, and more extensible
'format than pre-3.1 servers.

if print_email_body_flag$ <> "true" then
call append_3point1_data (_
      temp_file_name$,_
      router_event_flag$,_
      task_event_flag$,_
      docbase_name$,_
      event_name$,_
      sender_name$,_
      recipient_name$,_
      recipient_login_name$,_
      object_name$,_
      message_text$,_
      router_name$,_
      router_id$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      package_id$,_
      task_priority$,_
      due_date$,_
      planned_start_date$,_
      stamp$)
end if 'if flase

'Append server 3.0-style computer-readable info:
'(NOTE: the following call is commented out by default,
'but may be commented back in if needed by email-reading
'scripts and programs that depend on the pre-server 3.1
'email format.)

if false then
call append_3point0_data (_
      temp_file_name$,_
      docbase_name$,_
      event_name$,_
      sender_name$,_
      recipient_name$,_
      object_name$,_
      message_text$,_
      router_name$,_
      router_id$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      package_id$,_
      task_priority$,_
      due_date$,_
      planned_start_date$)
end if 'if false

' append bcc addresses if this is a single-message bulk mail
If do_single_message = True Then
Call append_single_message_bcc_data(_
    temp_file_name$,_
    single_message_address_list$,_
    single_message_address_count)
End If

' Close the file which now contains the message body:

close #2

'Send the completed email:

If platform$ = "WIN32" Then
    mailScript$ = ".\smail.exe"
    mailCommand$ = mailScript$ _
    & " " & "-nohttp" _
    & " " & "-delete_contents" _
    & " " & "-S " & subject_line$ _
    & " " & "-A " & recipient_name$ _
    & " " & "-F " & temp_file_name$ _
    & " " & "-Server " & smtp_server$ _
    & " " & "-M " & mail_user_name$
Else
    ' We must change the recipient if this is a single message bulk-mail.
    If do_single_message = True Then
        recipient_name$ = sender_name$
    End If

    mailCommand$ = mailScript _
    & " " & "-delete_contents" _
    & " " & subject_line$ _
    & " """ & recipient_name$ & """" _
    & " " & temp_file_name$
End If
'Print "mailCommand= " & mailCommand$
result% = ShellSync(mailCommand)
'Print "Result of mail execution: " & result%

If FileExists(temp_file_name) Then
Kill temp_file_name
End If

Loop While bulk_mail_file$ <> " " And do_single_message = False

'Clean up and exit:
If bulk_mail_file$ <> " " Then
close #3
Kill bulk_mail_file$
End If

dmExit(result)

end sub 'mail

'------------------------------------------------------------
'This subroutine creates the required portion of server-
'generated emails: the subject line and opening paragraph(s).
'It also sets up some variables that are used by subsequent
'subroutines.

'Note: The generated subject line MUST begin and end
'with double-quote chars because it is passed as a quoted-
'string on the command line that invokes the mail-sending command.

sub construct_required_email_parts (_
      temp_file_name$,_
      docbase_name$,_
      event_name$,_
      message_text$,_
      object_name$,_
      router_name$,_
      sender_name$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      recipient_name$,_
      object_info_flag$,_
      task_event_flag$,_
      router_event_flag$,_
      print_email_body_flag$,_
      subject_line$,_
      package_id$,_
      router_id$)

'Initialization:

If platform_type$ = "WIN32" Then
    subject_line_header$ = """!! "
    subject_line_trailer$ = """"
Else
    subject_line_header$ = "'!! "
    subject_line_trailer$ = "'"
End If

'Generate the correct subject and opening sentence
'depending on which event occurred:

Print #2, "In docbase """ & docbase_name & """:"
print #2, ""

Select Case event_name$

'non-router-related events:

   Case "dm_checkin"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    print_email_body_flag = "true"
    subject_line = "Checked In: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    subject_note = "The following document was checked in by " & sender_name

   Case "dm_checkout"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    print_email_body_flag = "true"
    subject_line = "Checked Out: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    subject_note = "The following document was checked out by " & sender_name

   Case "dm_destroy"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Destroyed: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ destroyed object """ & object_name & """."

   Case "dm_fetch"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Fetched: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ fetched object """ & object_name & """."
   Case "dm_lock"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Locked: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ locked object """ & object_name & """."

   Case "dm_unlock"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Unlocked: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ unlocked object """ & object_name & """."

   Case "dm_branch"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Branched Version Tree: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ added a new branch to the version tree of object """ & object_name & """."

   Case "dm_prune"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Pruned Version Tree: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ removed a branch from the version tree of object """ & object_name & """."

   Case "dm_mark"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Marked: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ marked object """ & object_name & """."

   Case "dm_save"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    print_email_body_flag = "true"
    subject_line = "Saved: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    subject_note = "The following document was saved by " & sender_name

   Case "dm_status"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Changed Status: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ changed the status of object """ & object_name & """."

   Case "dm_link"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Linked: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ linked object """ & object_name & """ to a cabinet or folder."

   Case "dm_unlink"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Unlinked: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ unlinked object """ & object_name & """ from a cabinet or folder."

   Case "dm_archive"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Archiving Requested: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ requested that object """ & object_name & """ be archived."

   Case "dm_archive_done"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Archived: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ archived object """ & object_name & """."

   Case "dm_restore"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Restoration Requested: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ requested that object """ & object_name & """ be restored from the archive."

   Case "dm_restore_done"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Restored: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ restored object """ & object_name & """ from the archive."

   Case "dm_getfile"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    print_email_body_flag = "true"
    subject_line = "Read Notification: " & CleanQuote(object_name)
    subject_note = "The following document was read by " & sender_name

'Special events:

   Case "Job_Failure"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Failed: Job " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "Job """ & object_name & """ failed to execute successfully. The message was: """ & message_text & """"

   Case "Agent_Exec_Failure"
    object_info_flag = "true"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Failed: Method ""agent_exec_method"" in docbase " & CleanQuote(docbase_name)
    print #2, "The method ""agent_exec_method"" failed to execute successfully. The message was: """ & message_text & """"

   Case "DM_SYSADMIN"
    object_info_flag = "true"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Posted Event: " & CleanQuote(event_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ posted event """ & event_name & """ with this message: """ & message_text & """"

'Router-only events:

   Case "dm_end"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "true"
    subject_line = "Terminated: Router " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ terminated the operation of router """ & router_name & """."

   Case "dm_halt"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "true"
    subject_line = "Halted: Router " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ halted the operation of router """ & router_name & """."

'Router plus task events:

   Case "dm_acquire"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Acquired: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ acquired object """ & object_name & """."

   Case "dm_force"
    object_info_flag = "true"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Task Readied: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ forced task """ & task_name & """ of router """ & router_name & """ into the READY state."

   Case "dm_forward"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Forwarded: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ forwarded object """ & object_name & """ with this message: """ & message_text & """."

   Case "dm_reassign"
    object_info_flag = "true"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Reassigned: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ reassigned task """ & task_name & """ of router """ & router_name & """ to a different user."

   Case "dm_route"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Routed: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ routed object """ & object_name & """ with this message: """ & message_text & """."

   Case "dm_signoff"
    object_info_flag = "true"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Signed: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ signed task """ & task_name & """ of router """ & router_name & """ with this message: """ & message_text & """."

   Case "dm_start"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Routed: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ routed object """ & object_name & """ with this message: """ & message_text & """."

   Case "dm_reverse"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Rejected: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ rejected object """ & object_name & """ with this message: """ & message_text & """."

   Case "dm_pause"
    object_info_flag = "true"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Paused: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ paused task """ & task_name & """ of router """ & router_name & """."

   Case "dm_resume"
    object_info_flag = "true"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Resumed: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ resumed task """ & task_name & """ of router """ & router_name & """."

   Case "dm_startedworkitem"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Started workitem: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ started workitem """ & package_id & """ with this message: """ & message_text & """."

   Case "dm_selectedworkitem"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Acquired workitem: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ acquired workitem """ & package_id & """."

   Case "dm_completedworkitem"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Completed workitem: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ completed workitem """ & package_id & """."

   Case "dm_pseudocompletedworkitem"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Pseudo-Completed workitem: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "Server completed workitem """ & package_id & """."

   Case "dm_reassignedworkitem"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Reassigned workitem: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ reassigned workitem """ & package_id & """ to """ & recipient_name & """."

   Case "dm_delegatedworkitem"
    object_info_flag = "false"
    task_event_flag = "true"
    router_event_flag = "true"
    subject_line = "Delegated workitem: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ delegated workitem """ & package_id & """ to """ & recipient_name & """."

   Case "dm_createworkflow"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Created workflow: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ created workflow """ & package_id & """."

   Case "dm_startworkflow"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Started workflow: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ started workflow """ & package_id & """."

   Case "dm_terminateworkflow"
    object_info_flag = "true"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Terminated workflow: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ terminated workflow """ & package_id & """."

   Case "dm_abortworkflow"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Aborted workflow: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ aborted workflow """ & package_id & """."

   Case "dm_changestateworkflow"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Changed workflow state: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ changed workflow state for """ & package_id & """."

   Case "dm_changeworkflowsupervisor"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Changed workflow supervisor: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ changed the supervisor to you for workflow """ & package_id & """."

   Case "dm_abortactivity"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Aborted activity for workflow: " & CleanQuote(router_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ aborted activity """ & object_name & """."

   Case "dm_autotransactivity"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Selected route case for workflow: " & CleanQuote(router_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ selected route case """ & task_priority & """ for activity """ & object_name & """."

   Case "dm_changestateactivity"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Activity change state for workflow: " & CleanQuote(package_id) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ changed activity state for activity """ & object_name & """."

   Case "dm_changestateprocess"
    object_info_flag = "false"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Change state process: " & CleanQuote(object_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ change process state for """ & object_name & """."

'User-defined events:

   Case Else
    object_info_flag = "true"
    task_event_flag = "false"
    router_event_flag = "false"
    subject_line = "Posted Event: " & CleanQuote(event_name) & " in docbase " & CleanQuote(docbase_name)
    print #2, "User """ & sender_name & """ posted event """ & event_name & """ with this message: """ & message_text & """."

End Select

'(NOTE: The subject line must begin and end with double-quote chars.)

subject_line = subject_line_header & subject_line & subject_line_trailer

'Clean up and exit:

end sub 'construct_required_email_parts

'------------------------------------------------------------
'This subroutine appends a section of user-readable details
'about the target object if appropriate for the current event.

sub append_object_info (_
      temp_file_name$,_
      object_name$,_
      object_info_flag$)

if object_info_flag = "true" then

'Initialization:

'Append section heading and info about the "object" of the event:

print #2, ""
print #2, ""
print #2, ""
print #2, "------------------------------"
print #2, "OBJECT DETAILS"
print #2, "------------------------------"
print #2, "Object Name..........." & object_name

'Clean up and exit:

end if 'object_info_flag

end sub 'append_object_info

'------------------------------------------------------------
'This subroutine appends a section of user-readable details
'about the router and task as appropriate for the current event.

sub append_routing_info (_
      temp_file_name$,_
      docbase_name$,_
      due_date$,_
      event_name$,_
      message_text$,_
      object_name$,_
      package_id$,_
      planned_start_date$,_
      priority$,_
      router_id$,_
      router_name$,_
      sender_name$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      recipient_name$,_
      router_event_flag$,_
      task_event_flag$)

if (router_event_flag = "true") or (task_event_flag = "true") then

'Initialization:

'Append section heading:

print #2, ""
print #2, ""
print #2, ""
print #2, "------------------------------"
print #2, "ROUTING DETAILS"
print #2, "------------------------------"

'Append task info:

if task_event_flag = "true" then
print #2, "Task Name............." & task_name
print #2, "Due Date.............." & due_date
print #2, "Planned Start Date...." & Planned_start_date
print #2, "Priority.............." & priority
print #2, ""
end if 'task_event_flag

'Append router info:

if router_event_flag = "true" then
print #2, "Router Name..........." & router_name
print #2, "Raison sociale....." & mgb_raison_sociale
print #2, "Sender................" & sender_name
print #2, "Recipient............." & recipient_name
end if 'router_event_flag

'Clean up and exit:

end if 'router or task event

end sub 'append_routing_info

'------------------------------------------------------------
'This subroutine appends a server 3.1-style,
'computer-readable data block to the email body.

sub append_3point1_data (_
      temp_file_name$,_
      router_event_flag$,_
      task_event_flag$,_
      docbase_name$,_
      event_name$,_
      sender_name$,_
      recipient_name$,_
      recipient_login_name$,_
      object_name$,_
      message_text$,_
      router_name$,_
      router_id$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      package_id$,_
      task_priority$,_
      due_date$,_
      planned_start_date$,_
      stamp$)

'Initialization:

data_line_header$ = ">>>"

'Append user-readable section heading:

print #2, ""
print #2, ""
print #2, ""
print #2, "------------------------------"
print #2, "COMPUTER-READABLE DATA"
print #2, "------------------------------"

'Append data block header:

print #2, data_line_header & "begin_data_block"
print #2, data_line_header & "data_block_type=docbase_event"
print #2, data_line_header & "data_block_name=none"

'Append data pertaining to all events:

print #2, data_line_header & "docbase_name=" & docbase_name
print #2, data_line_header & "event_name=" & event_name
print #2, data_line_header & "sender_name=" & sender_name
print #2, data_line_header & "recipient_name=" & recipient_name
print #2, data_line_header & "recipient_login_name=" & recipient_login_name
print #2, data_line_header & "object_name=" & object_name
print #2, data_line_header & "message_text=" & message_text
print #2, data_line_header & "queue_item_id=" & stamp

'Append data pertaining to router-related events:

if (task_event_flag = "true") or (router_event_flag = "true") then
'OPTIONAL: print #2, data_line_header & "router_name=" & router_name
print #2, data_line_header & "router_id=" & router_id
'OPTIONAL: print #2, data_line_header & "mgb_raison_sociale=" & mgb_raison_sociale
end if

'Append data pertaining to task-related events:

if (task_event_flag = "true") then
'OPTIONAL: print #2, data_line_header & "task_name=" & task_name
print #2, data_line_header & "task_number=" & task_number
print #2, data_line_header & "package_id=" & package_id
'OPTIONAL: print #2, data_line_header & "task_priority=" & task_priority
'OPTIONAL: print #2, data_line_header & "due_date=" & due_date
'OPTIONAL: print #2, data_line_header & "planned_start_date=" & planned_start_date
end if

'Append data block trailer:

print #2, data_line_header & "end_data_block"

'Clean up and exit:

end sub 'append_3point1_data

'------------------------------------------------------------
'This subroutine appends a server 3.0-style,
'computer-readable data block to the email body.

'Warning: Since the last data item (message_text$) appended
'by this subroutine is raw ASCII data with no identifiable
'termination delimiter, it must be the last thing appended
'to the email body so that the end of file may act as an
'implicit terminator.

sub append_3point0_data (_
      temp_file_name$,_
      docbase_name$,_
      event_name$,_
      sender_name$,_
      recipient_name$,_
      object_name$,_
      message_text$,_
      router_name$,_
      router_id$,_
      mgb_raison_sociale$,_
      task_name$,_
      task_number$,_
      package_id$,_
      task_priority$,_
      due_date$,_
      planned_start_date$)


'Initialization:

'Append user-readable section heading:

print #2, ""
print #2, ""
print #2, ""
print #2, "------------------------------"
print #2, "COMPUTER-READABLE DATA"
print #2, "------------------------------"

'Append data values:

print #2, ""
print #2, ""
print #2, ""
print #2, "DOCBASE:";Tab(18);docbase_name
print #2, "EVENT: ";Tab(18);event_name
print #2, "NAME: ";Tab(18);object_name
print #2, "SENT BY: ";Tab(18);sender_name

'Some information is printed out only if router_id$ is not dm_null_id.

If router_id$ <> "dm_null_id" Then
   print #2, "ROUTER ID:";Tab(18);router_id
   print #2, "SUPERVISOR NAME:";Tab(18);mgb_raison_sociale
   print #2, "TASK NUMBER:";Tab(18);task_number
If planned_start_date$ <> "nulldate" Then
   print #2, "PLAN START DATE: ";Tab(18);planned_start_date
End If
End If
   print #2, "TASK NAME: ";Tab(18);task_name
   print #2, ""
   print #2, "MESSAGE: "
   print #2, ""
   print #2, message_text
   print #2, ""
   print #2, ""

'Clean up and exit:

end sub 'append_3point0_data

Sub append_single_message_bcc_data (temp_file_name$,_
address_list() As String,_
address_count As Integer)

' Declarations
Dim index As Integer

' Initialization
index = 0

' Loop through and add each bcc address as a new line in the file
While index < address_count
Print #2, "~b " & address_list(index)
index = index + 1
Wend

End Sub 'append_single_message_bcc_data

'------------------------------------------------------------
'This function takes takes a string as input.
'It first makes any modifications necessary to insure that
'the string can safely be used as a substring in a command-line
'argument to the command that actually sends the email.
'It then adds "\ character pairs at both ends of the new string
'(if they're not already there) so that the string will be surrounded
'by escaped double-quote marks.

function CleanQuote$(GivenString$)

TempString$ = ""
length% = Len(GivenString$)

If platform_type$ = "WIN32" Then
    'First, "clean" the string: put a \ in front of ", put " around < > ! | &
    for i = 1 to length%
      checking$ = Mid$(GivenString$,i,1)
      if checking$ = """" then
        TempString$ = TempString & "\"""
      elseif checking$ = ">" or checking$ = "<" or checking$ = "!" or checking$ = "&" or checking$ = "|" then
        TempString$ = TempString & """" & checking$ & """"
      else
        TempString$ = TempString & checking$
      end if
    next i

    'Second, "quote" the cleaned string:
    if left$(TempString,2) <> "\""" then
      TempString$ = "\""" & TempString
    end if

    if right$(TempString,2) <> "\""" then
      TempString$ = TempString & "\"""
    end if
Else
    'First, "clean" the string: replace ' with '\''
    for i = 1 to length%
      checking$ = Mid$(GivenString$,i,1)
      if checking$ = "'" then
        TempString$ = TempString & "'\''"
      else
        TempString$ = TempString & checking$
      end if
    next i

    'Second, "quote" the cleaned string:
    if left$(TempString,1) <> """" then
      TempString$ = """" & TempString
    end if

    if right$(TempString,1) <> """" then
      TempString$ = TempString & """"
    end if
End If

CleanQuote$ = TempString
end function 'CleanQuote

'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
'
'
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Sub PrintEmailBody(fileNum%,object_name$,objectid$,docbasename$,subjectnote$)

Dim query_str as String
Dim folder_query_str as String
Dim userOSName as String
Dim sess as String
Dim title as String
Dim lastModDate as String
Dim folderId as String
Dim folderPath as String
Dim status as Integer

userOSName = dmAPIGet("get,apisession,apiconfig,r_process_user_name")
sess = dmAPIGet("connect," & docbasename$ & "," & userOSName & ",")
If (sess <> "") Then

    'Query for primary folder path
    query_str = "select title, r_modify_date, i_position, i_folder_id from dm_sysobject where r_object_id='" & objectid$ & "' order by i_position desc"
    query_id$=dmAPIGet("query,c," & query_str)

If ( (query_id <> "") And (dmAPIExec("next,c," & query_id ) > 0) ) Then

      title=dmAPIGet("get,c," & query_id & ",title")
      lastModDate=dmAPIGet("get,c," & query_id & ",r_modify_date")
      folderId=dmAPIGet("get,c," & query_id & ",i_folder_id")

      If ( folderId <> "") Then
        folder_query_str ="select r_folder_path from dm_folder where r_object_id='" & folderId & "' order by i_position desc"
        folder_query_id$=dmAPIGet("query,c," & folder_query_str)
        If ( (folder_query_id <> "") And (dmAPIExec("next,c," & folder_query_id ) > 0) ) Then
          folderPath$=dmAPIGet("get,c," & folder_query_id & ",r_folder_path")
        End If
        status = dmAPIExec("close,c," & folder_query_id)
        If (status <> 1) Then
          Call ErrHandler(sess)
        End If
      End If

End If

    status = dmAPIExec("close,c," & query_id)
    If (status <> 1) Then
      Call ErrHandler(sess)
    End If

    'Disconnect session
    status = dmAPIExec("disconnect," & sess)
    If (status <> 1) Then
      Call ErrHandler(sess)
    End If

End If

Print # fileNum, subjectnote$
Print # fileNum, ""

Print # fileNum, "Name: " & object_name$
If (title <> "") Then
Print # fileNum, "Title: " & title
End If

If (lastModDate <> "") Then
Print # fileNum, "Last Modified: " & lastModDate
End If

If (folderPath <> "") Then
Print # fileNum, "Location: " & folderPath
End If

End Sub

Sub ErrHandler(sess As String)
Dim cmd As String
Dim mssg As String

   cmd = "getmessage," & sess & ",3"
   mssg$ = dmAPIGet(cmd)
   If (mssg$ <> "") Then
    Print mssg$
   End If
End Sub

DCTM_Guru

You cant just add arguments (eg mgb_raison_sociale$) to out of box server method. The content server is only going to pass defined values via arguments. You need to run your own query within the code to get your attribute values and then pass that as part of the email.

MoroccoDCTM

Dose anybody know the syntax to run the query within the code?

DCTM_Guru

Try searching for "docbasic query":

https://community.emc.com/message/48755