Category: Automation Document Actions

The Mail Merge Record Collection Action Builder retrieves records that match a Criteria and merges those records with a mail merge template.

Select the record type that will be merged with the template.

The Record Criteria will be used to ascertain which records to retrieve from the database.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Select the Document Object Type that will contain your template.

The Template Criteria will be used to ascertain what document to be retrieved.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be documentName.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Click Yes to save the document as a Pdf.

File Path – the variable that will hold the path to the new document file. Note: this variable needs to be set before this point in the script.

Deleting the File Path variable name will bypass the saving file portion of the script.

Selecting Yes will send the document contents to the default printer.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Get Records – retrieves the records, in the database, that matches a Criteria and sets that record to a variable.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with. This parameter is for the document template.

Find Record By Criteria – retrieves the template record, in the database, that matches a Criteria and sets that record to a variable.

Get Record Content – gets the document content from the record.

New Document Item – creates a new DocumentItem and sets that to a variable.

Set DocumentItem Content – sets the newly created DocumentItem content to the record content variable.

Document Mail Merge – generates the template mail merge using all records retrieved.

Save Pdf File – takes a path and saves the final mail merge contents to that path.

Print Document – sends the final mail merge content to the default printer.

The Mail Merge Loop Action Builder retrieves a group of records, loops through each record and merges that record with a mail merge template.

Select the record type that will be merged with the template.

The Record Criteria will be used to ascertain which records to retrieve from the database.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be statename.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Select the Document Object Type that will contain your template.

The Template Criteria will be used to ascertain what document to be retrieved.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be documentName.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Click Yes to save the document as a Pdf.

File Path – the variable that will hold the path to the new document file. Note: this variable needs to be set before this point in the script.

Deleting the File Path variable name will bypass the saving file portion of the script.

Selecting Yes will send the document contents to the default printer.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Record By Criteria – retrieves the template record, in the database, that matches a Criteria and sets that record to a variable.

Get Record Content – gets the document content from the record.

New Document Item – creates a new DocumentItem and sets that to a variable.

Set DocumentItem Content – sets the newly created DocumentItem content to the record content variable.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with. This parameter is for the records.

Get Records – retrieves all records that match the Criteria.

Loop Record Collection – loops through all the records that were retrieved.

Document Record Mail Merge – generates the mail merge record with template.

Save Pdf File – takes a path and saves the final mail merge contents to that path.

Print Document – sends the final mail merge content to the default printer.

The Mail Merge Record Action Builder retrieves a mail merge template from the database and merges with one record.

Select the record type that will be merged with the template.

Choose the variable that will contain the record id to be merged.

Select the Document Object Type that will contain your template.

The Template Criteria will be used to ascertain what document to be retrieved.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be documentName.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Click Yes to save the document as a Pdf.

File Path – the variable that will hold the path to the new document file. Note: this variable needs to be set before this point in the script.

Deleting the File Path variable name will bypass the saving file portion of the script.

Selecting Yes will send the document contents to the default printer.

Get Record Data – retrieves a record, from the database, using the ID.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Record By Criteria – retrieves the first record, in the database, that matches a Criteria and sets that record to a variable.

Get Record Content – gets the document content from the record.

New Document Item – creates a new DocumentItem and sets that to a variable.

Set DocumentItem Content – sets the newly created DocumentItem content to the record content variable.

Document Record Mail Merge – generates the mail merge record with template.

Save Document File – takes a path and saves the final mail merge contents to that path.

Print Document – sends the final mail merge content to the default printer.

The Save Document to File Action builder retrieves a document form the database and saves it to a local directory.

Select the Document Object Type that will be retrieved.

Click the arrow on the right to select from a list of object types.

Click next once one is selected.

The Document Criteria will be used to ascertain what document to be retrieved.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be documentName.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Click Yes to save the document as a Pdf.

File Path – the variable that will hold the path to the new document file. Note: this variable needs to be set before this point in the script.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Record By Criteria – retrieves the first record, in the database, that matches a Criteria and sets that record to a variable.

Get Record Content – retrieves the document content from the record and places it into a variable.

New Document Item – creates a new DocumentItem and sets that to a variable.

Set DocumentItem Content – sets the newly created DocumentItem content to the record content variable.

Save Document File – takes a path and saves the document contents using that path.

The Update Document from File will retrieve a document record by ID and store the contents into a DocumentItem.

All specified properties will also be stored into variables.

Select the Business Object Type that will be updated.

Click the arrow on the right to select from a list of object types.

Click next once one is selected.

The Document Criteria will be used to ascertain what document to be retrieved.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be documentName.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Select the properties, of the object type, that will be set.

Select the Property.

Type in a Variable name or select from a list of existing Variables that will hold the value of the property.

Click the Plus button to add that property to the list to be retrieved.

Click Finish once all property values have to be retrieved have been added.

Note: All property variables will need to be set prior to running this portion of the script.

The variable that will hold the path to the document file.

You can type in any variable name or select existing variables from the drop down.

Note: this variable will need to be set to the actual path prior to portion of the script.

New Document Item – creates a new DocumentItem that will be used in loading the file. Imagine the DocumentItem as your wordprocessor application.

Load Document File – this takes the DocumentFile and passes the path to the local file to be loaded.

Get DocumentItem Content – retrieve the Rtf content of the document file and set it to a variable.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Record By Criteria – retrieves the first record, in the database, that matches a Criteria and sets that record to a variable.

Set DocumentName – this sets the Property to the value of a variable. There will be a Set Property action for each property that was added. Note: these variables will need to be set prior to this portion of the script.

Set Record Content – sets the record content to the variable that holds the DocumentItem content.

Commit All Changes – saves all changes to the database.

The Get Document from the Database will retrieve a document record by ID and store the contents into a DocumentItem.

All specified properties will also be stored into variables.

Select the Business Object Type that will be retrieved.

Click the arrow on the right to select from a list of object types.

Click next once one is selected.

The Document Criteria will be used to ascertain what document to be retrieved.

Values can be passed into Criteria by creating a parameter.

By enclosing a value in { } brackets, that flags the word as a parameter. The name of the parameter, in the picture, would be documentName.

Parameters will have the value substituted during the script execution.

If parameters are found in the Criteria, they wil be listed in the Name drop down.

Name – the name of the parameter within the criteria.

Type – type of value to be expected (String, Bool, Date, Decimal, Number).

Variable – the variable that will hold the value. The drop down will contain existing variables or type in a new variable name.

Click the Add button to add the parameter name and value to be substituted.

Select the properties, of the object type, that will be retrieved.

Select the Property.

Type in a Variable name or select from a list of existing Variables that will hold the value of the property.

Click the Plus button to add that property to the list to be retrieved.

Click Finish once all property values have to be retrieved have been added.

Note: All property variables will need to be set prior to running this portion of the script.

Selecting Yes will send the document contents to the default printer.

Add Text Criteria Parameter – maps a Criteria Parameter to a value to be substituted with.

Find Record By Criteria – retrieves the first record, in the database, that matches a Criteria and sets that record to a variable.

Get Property (Get DocumentName) – this retrieves the value of the property and puts that value into a variable. There will be a Get Property action for each property that was added.

Get Record Content – retrieves the document content from the record and places it into a variable.

New Document Item – creates a new DocumentItem and sets that to a variable.

Set DocumentItem Content – sets the newly created DocumentItem content to the record content variable.

Print Document – prints the content from the DocumentItem.

This New Document from File Action Builder will load a document file from the hard drive and create a record to store the contents of the document into the database.

Select the Business Object Type that will be created.

Click the arrow on the right to select from a list of object types.

Click next once one is selected.

Select the properties, of the object type, that will be set.

Select the Property.

Type in a Variable name or select from a list of existing Variables that will hold the value of the property.

Click the Plus button to add that property to the list to be retrieved.

Click Finish once all property values have to be retrieved have been added.

Note: All property variables will need to be set prior to this portion of the script.

The variable that will hold the path to the document file.

You can type in any variable name or select existing variables from the drop down.

Note: this variable will need to be set to the actual path prior to portion of the script.

New Document Item – creates a new DocumentItem that will be used in loading the file. Imagine the DocumentItem as your wordprocessor application.

Load Document File – this takes the DocumentFile and passes the path to the local file to be loaded.

New Document Record – this will create a new database record to which the contents of the file will be set.

Set Document Name – this sets the Property to the value of a variable. There will be a Set Property action for each property that was added. Note: these variables will need to be set prior to this portion of the script.

Get DocumentItem Content – gets the document content and places it into a variable.

Set Record Content – takes the content from the variable and sets it to the record content property.

Commit Changes – saves all changes to the database.

Action Builders are step by step wizards that help you build scripts quickly.

Click on the Action Builder and the Action Builder Wizard will pop up.

Appends TEXT content to the end of the document.

Click the Click for Options link to bring up the Options dialog.

Document – the DocumentItem being used
Value – the TEXT content to be appended.

Appends HTML content to the end of the document.

Click the Click for Options link to bring up the Options dialog.

Document – the DocumentItem being used.
Value – the HTML content that will be appended.