ProjectWise Administrator Help

New Messaging Agent Wizard

Used to walk you through the process of creating a messaging agent. A messaging agent contains rules for having messages automatically generated and sent to designated users when a certain document action occurs. This section documents all the possible pages (in order of appearance) that you can encounter in the New Messaging Agent Wizard.

SettingDescription
Defining the messaging agent page Used to define the subject, text and type of the messaging agent.
  • Message subject — Defines the subject of the message. For example "Document moved to next state". This field is required.
  • Message text — Allows you to add further comments if the message subject is not sufficient information. For example, "The attached document is now available for updating." This field is optional.
  • Message type - Email — If set, the messaging agent will generate a message to be sent through email. The generated message will be sent to selected user(s) and group(s) who have an email address entered in their Properties. Users within groups must each have an email address entered in their user properties. When the message is sent, an error message is displayed for each user without an email address.
  • Message type - ProjectWise message — If set, the messaging agent will generate a message to be sent through ProjectWise Messenger. The generated message can be sent to selected ProjectWise users, groups, and/or user lists with appropriate access rights.
  • Attach Document — If on, a link to the relevant document is attached to the message when the message is sent.
Specifying message recipient page Used to select the Users and Groups who will receive the message.
  • Users that have access to the document, on which command is executed — If on, only users who have access rights to the affected document(s) will receive a message when the messaging agent is triggered.
  • Users and Groups list — Displays the list of users and groups selected to receive the message. This option may be used in conjunction with the check box option above, or as an alternative
  • Add — Opens the Select User or Group dialog, which is used to add users or groups to the list of message recipients. In the Select User or Group dialog, select a user or group, then click OK.
  • Remove — Removes the selected user or group from the list.
Specifying message sending mode page Used to specify whether or not a notification will be displayed when the message is sent.
  • Send the message silently — If on, the generated message will be sent to the specified users, without notification.
  • Show dialog to send the message — If on, the user who performs the action on the document which triggers the messaging agent will receive a notification that a message has been sent on his or her behalf.
Specifying command type and sending time page
  • Command type - Document check in — If selected, a message will be generated whenever a document in the selected folder(s) is checked in.
  • Command type - Document check out — If selected, a message will be generated whenever a document in the selected folder(s) is checked out.
  • Command type - Document export — If selected, a message will be generated whenever a document in the selected folder(s) is exported.
  • Command type - Document state change — If selected, a message will be generated whenever a document is moved to another state in the selected workflow(s).
  • Command type - Document version change — If selected, a message will be generated whenever a new version of a document in the selected folder(s) is created.
  • Command type - Refresh server copy — If selected, a message will be generated whenever a user working in ProjectWise-integrated MicroStation updates the server copy of a document in the selected folder(s).
  • Send the message just before command ... execution / when document leaves the current state — If on, the message will be sent just after the user initiates the command, and just before ProjectWise has a chance to execute the command. For state changes, the message will be sent when the associated document leaves the current state.
  • Send the message when the command ... execution is finished / when document comes into the new state — If on, the message will be sent after ProjectWise executes the command. For state changes, the message will be sent when the associated document moves into a new state.
Attaching Folder to Document Agent page Used to select the folders containing the documents that will initiate the sending of messages. This page opens when you select Document check in, Document check out, Document export, Document version change, or Refresh server copy as the Command type.
  • Add — Opens the Add Folder dialog, from which you can select a folder to add to list of folders considered by the messaging agent.
  • Remove — Removes the selected folder from the list of folders considered by the messaging agent.
Attaching Workflow State to Workflow Agent page

Used to specify the state that has to change in order to initiate the sending of the message. This page opens when you select Document state change as the Command type.

  • Add — Opens the Select Workflow State dialog, from which you can select a workflow and state to add to list of states considered by the messaging agent.
  • Remove — Removes the selected workflow and state from the list of states considered by the messaging agent.