Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Distribution rules in RIB CX are a useful way to set up automatic pre-addressing of forms as well as restricting addressees and many other customised addressing options.

The Distribution Rule or List will only be applicable to the user that creates it. 

To Create a Distribution Rule / List

1. Create the new form which you want the Distribution Rule to apply and click on the action or info buttons to bring up the Address Book.

2. Click on the Distribution Lists drop down menu. Choose what you would like to create.

3. Fill in the required information.

As a Project Administrator you can create a Distribution Rule or List applicable to everyone on the Project.  These are created when documents require either the Action of, or to be Info'd to a specific user each time they are used. Users have the ability to create distribution rules / lists however these are only applicable to that user.

Distribution Lists are pre-defined lists of users for the Attention and CC on documents. They are useful for documents that are frequently sent to the same recipients. Rather than choosing names from the Address Book, you simply choose a Distribution List.

When you create a new document you can choose the desired Distribution List(s) to address the document, however, distribution lists are still subject to Distribution Rules for their document type.

Distribution Rules are created when documents require either the attention of, or copying to a specified user each time they are used. The Rule specifies what names are shown in Action and Info.

The rule can limit the names that are shown in the address book, and can pre-select names so that the document is already addressed when you create a new document.

Rules are particularly useful for users who always address a particular document type to the same person.

Document Types like Incoming Email require a Distribution Rule so that someone is responsible for their distribution.

Creating a Distribution Rule / List

1. Go to Configure.

2. Select Form Types. 

3. Select Edit Distribution Rules.

4. Ensure you are on the correct tab for what you want to create i.e. Distribution Rules Tab or Distribution Lists Tab.

5. Select Add New.

6. Fill in the required information.

Display Applicable Distribution Rules on the Distribution Window

Distribution rules application for a DTX will now be shown on the distribution screen directly

As a user...

You will notice those recipients appear with heading "Distribute to these recipients". This ensures you see the auto distribution contacts in the distribution window 

Brief Description of Distribution Rule Elements 

NameEnter the name of distribution rule.
DescriptionEnter the description of distribution rule.
OwnerWho can edit the distribution rule.   
ApplicabilitySelect who this rule applies to.  That is, who can see and use this distribution rule. 
Show ExclusionsToggle on Show Exclusions to see or add users / groups / companies etc that are excluded.
Apply to All Doc TypesToggle on if you want this distribution rule to apply to all documents.
Form Type

Choose the form types this rule will apply to.

When creating a Distribution List that you want to apply to documents being distributed in the publication you need to select the TX form in the Form Type.  This will enable the Distribution List to appear in the Distribution drop down.

Scope

Select when this rule or list is to be applied.  The options are:

  • Creation
  • Replies
  • Creation And Replies
  • Manual

1. The pre-addressing options apply to Document creation only, regardless of whether you select "Document Creation and Replies".  This means when someone replies to the document, they may change the addressing options (except if the addressee is "Forced").  

2. Limiting the available names by ticking the "Exclude" checkbox applies to both Document creation and Document replies. This means when someone replies to the document, they will still not see excluded names in the Address Book.

ActionEnter names of people (see below).
InfoEnter names of people (see below).
ExcludeTick the checkbox "Exclude" to ensure that on Creation and Replies the user is not available in the address book. 

When you select a user to either Action or Info on your document, you must tick a checkbox. Options are:

  • Enumerate - the item is expanded from a single "Group" entry into a list of the individual users in that group. This parameter is ignored if the code is 'PRIVATE' or an individual user. 
  • Preferred - the item is listed in a "preferred" section at the top of the address-book.
  • Selected - addressees are pre-selected.
  • Forced - addressees are pre-selected and may not be removed.
  • Silent - addressees will not get an item on their ToDo notifications list. This might be used in CCs to ensure someone has access to documents, but they do not want a ToDo Notification every time those documents are created or edited.

6. Click Save.

For how to use distribution rules click here.

Bypassing the Who Talks To Whom Matrix Using a Distribution Rule

In certain circumstances it is necessary to by-pass the who talks to whom matrix.  For instance, you may need a particular subcontractor to communicate directly with a consultant.

To achieve this, Distribution Rules can be created which by-pass the security configuration set for the project.  A Project Administrator must create this rule.

To do this follow the steps listed above to create one distribution rule for the "Subcontractor" and one distribution rule for the "Consultant". e.g.

Name

Choose a name for the rule e.g. SUB12CON1.

Title

Type full name e.g. Subcontractor1 to Consultant1

Type

You must choose Rule

Applicability

Choose the company that this rule is for i.e.: Subcontactor1 or Consultant1

Doc Type

Choose the document type this rule applies to or leave ALL

Scope

Choose when it applies i.e. creation & replies

Addressing

In the TO List Enter the Company Code (for the company you need to communicate with) dash star (to include all users in that company) i.e. CONS1-*

Once this process is complete the nominated Subcontractor and Consultant will be able to communicate directly with each other.

Address everyone or a company or role on a Form (Modern Forms)

'Everyone on the project [ALL]' enables users to address everyone on the project or specific companies and roles without needing to enumerate each recipient.

Addressing Options:

Users can address "everyone on the project/all" or select specific companies or roles via a rule or list.

Enumeration of individual recipients is not required.

Form Creation:

When a form is created using these addressing options, only one form will be generated.

Addressing Section Display:

In the addressing section, the name of the company or role applied by the rule will be shown.

Notification:

Users are still notified based on their action notification settings when addressed in this manner.

History Log for a Distribution Rule / List / Workflow

Changes to the distribution rules, lists, and workflows (adding, deleting, editing) are now logged and can be viewed via the history button.

Changes made to individual rules, lists, and workflows can be viewed by clicking on the history button for each of those items.

Edit or Retire Distribution List

You can edit or retire distribution list by :

Going to Configure → Form Types → Edit Distribution Rules → Click 'Retire' or 'Edit'

OR

Go to Project tools → Contact details → Edit distribution rules → Click 'Retire' or 'Edit'

People who have the ability to edit or retire distribution list are :

  • Company/Project admins,
  • Author
  • Non-Admin User who created the distribution list 

Report on Distribution Rules, Lists & Groups

A report can be run against Rules, Lists and Groups to report on all the settings within each of those elements

Go to Configure → Form Types → Edit Distribution Rules. And click 'Report' on bottom right corner :

For Rules and Lists, a row per user will be added based on who has been added to Action or Info , along with the settings configured for each of those users.

Here is a sample of that report

History Log for Classic Correspondence Workflows

This is a retired feature.

Changes to Correspondence workflows are now logged and can be viewed via the history button.

Group Report - Show Applied Form Types for Groups

The group report shows form types where the group has been used, shown in the "Applied To Doc Type" column. This column will appear among all other columns. 

The Applied to Doc Type Column will be Filled Based on the Following Scenarios

1.Mapping user fields.

Go to Form → User Field → Options → Mapped User

2. Status Action - Post Action Criteria

Go to Form → under 'General' tab → expand 'Status' tab → click 'Status List'

3. The group has been used in a Workflow in the Publication within a workflow step

Go to Publication Space → Settings → click 'Workflows' tab → click 'Edit' on a workflow

NameEnter the name of distribution rule.
DescriptionEnter the description of distribution rule.
OwnerWho can edit the distribution rule.   
ApplicabilitySelect who this rule applies to.  That is, who can see and use this distribution rule. 
Show ExclusionsToggle on Show Exclusions to see or add users / groups / companies etc that are excluded.
Apply to All Doc TypesToggle on if you want this distribution rule to apply to all documents.
Form Type

Choose the form types this rule will apply to.

When creating a Distribution List that you want to apply to documents being distributed in the publication you need to select the TX form in the Form Type.  This will enable the Distribution List to appear in the Distribution drop down.

Scope

Select when this rule or list is to be applied.  The options are:

  • Creation
  • Replies
  • Creation And Replies
  • Manual

1. The pre-addressing options apply to Document creation only, regardless of whether you select "Document Creation and Replies".  This means when someone replies to the document, they may change the addressing options (except if the addressee is "Forced").  

2. Limiting the available names by ticking the "Exclude" checkbox applies to both Document creation and Document replies. This means when someone replies to the document, they will still not see excluded names in the Address Book.

ActionEnter names of people (see below).
InfoEnter names of people (see below).
ExcludeTick the checkbox "Exclude" to ensure that on Creation and Replies the user is not available in the address book. 

When you select a user to either Action or Info on your document, you must tick a checkbox. Options are:

  • Enumerate - the item is expanded from a single "Group" entry into a list of the individual users in that group. This parameter is ignored if the code is 'PRIVATE' or an individual user. 
  • Preferred - the item is listed in a "preferred" section at the top of the address-book.
  • Selected - addressees are pre-selected.
  • Forced - addressees are pre-selected and may not be removed.
  • Silent - addressees will not get an item on their ToDo notifications list. This might be used in CCs to ensure someone has access to documents, but they do not want a ToDo Notification every time those documents are created or edited.

6. Click Save.

For how to use distribution rules click here.

Bypassing the Who Talks To Whom Matrix Using a Distribution Rule

In certain circumstances it is necessary to by-pass the who talks to whom matrix.  For instance, you may need a particular subcontractor to communicate directly with a consultant.

To achieve this, Distribution Rules can be created which by-pass the security configuration set for the project.  A Project Administrator must create this rule.

To do this follow the steps listed above to create one distribution rule for the "Subcontractor" and one distribution rule for the "Consultant". e.g.

Name

Choose a name for the rule e.g. SUB12CON1.

Title

Type full name e.g. Subcontractor1 to Consultant1

Type

You must choose Rule

Applicability

Choose the company that this rule is for i.e.: Subcontactor1 or Consultant1

Doc Type

Choose the document type this rule applies to or leave ALL

Scope

Choose when it applies i.e. creation & replies

Addressing

In the TO List Enter the Company Code (for the company you need to communicate with) dash star (to include all users in that company) i.e. CONS1-*

Once this process is complete the nominated Subcontractor and Consultant will be able to communicate directly with each other.

History Log for Distribution Rules / Lists / Workflows

Changes to the distribution rules, lists, and workflows (adding, deleting, editing) are now logged and can be viewed via the history button.

Changes made to individual rules, lists, and workflows can be viewed by clicking on the history button for each of those items.

History Log for Classic Correspondence Workflows

This is a retired feature.

Changes to Correspondence workflows are now logged and can be viewed via the history button.


Name - type a name for your distribution rule.  It should be a short descriptive code. For example TX2MGT.

Title - type a meaningful title. It should describe the list. For example Transmittal to Management 

Type -  Rule or List.

Owner - who is the owner.

Applicability - this is set to you only.

Apply to All Doctype - if you want this rule/list to apply to all documents tick the box.  Otherwise, you can select which forms you want this rule/list to apply to.

Scope - When do you want this rule to apply. The options are Document creation and repliesDocument creation only, or Document replies only

1. The pre-addressing options apply to Document creation only, regardless of whether you select "Document Creation and Replies". This means when someone replies to the document, they may change the addressing Notify/Send options (except if the addressee is (+) "Forced").  
2. Limiting the available names by ticking the (-) Remove checkbox applies to both Document creation and Document replies. This means when someone replies to the document, they will still not see excluded names in the Address Book.

4. Now select who the users are that will be addressed on this distribution rule/list. 

Exclude - tick this box if you want to exclude this user from the rule.

User ID - choose the user you want to action.

Enumerate - if you have addressed a group, role or company tick this if you want to list each user rather than just the group, role or company name.

Preferred - show this user in the preferred list.

Selected - this user will appear in the address of the new form.

Forced - this user will be unable to be removed from the new form addressing.

Silent - this user will not receive a notification however can access the form at anytime. 

Remove - Remove this user from the distribution rule/list. 

Clicking on these arrows will move users up or down on the list of addressees.

5. Click Save.

6. You can access the configuration of the distribution rule through the Select Addressee window.

 

To Use a Distribution Rule / List

If a Distribution List is set up on a form to which you have access, you can select it from the Distribution List drop down.

When selected the users on this list will be addressed on your form. 

If a Distribution Rule is set up on a form to which you have access, as soon as you create a new form the users on the rule will be automatically addressed.

If a user is forced you cannot remove them and if you try you will receive a message.

To Edit a Distribution List

1. Click on the Project Tools icon and then Contact Details

2. Scroll down to just below the notifications section and click on Edit Distribution Rules.

3. A window will display all rules, lists and workflows that are accessible or editable by you. 

Click on Distribution Lists and then Edit.

4. Edit the Distribution List as required and click on save. 

Report on Distribution Rules, Lists & Groups

A report can be run against Rules, Lists and Groups to report on all the settings within each of those elements

For Rules and Lists, a row per user will be added based on who has been added to Action or Info , along with the settings configured for each of those users.

Here is a sample of that report

History Logs for Changes Made

Click here for additional information.

  • No labels