Working with Matrices

 

 

 

Matrices allow for the interception, tracking, reporting, and processing of data files on a three-dimensional coordinate system in which X represents a column in a grid, Y represents a row in a grid, and Z represents a particular date.  Matrix definitions provide a means by which users can manually upload files to pasUnity via the hosted pasPortal web application (which is available with a subscription) or through custom developed application interfaces.

 

When the Matrices node in the tree view navigation pane is selected the context pane displays the Matrix Name, Retention Days, Storage Limit (MB), Used Space (MB), Extraction Account, # of Columns, # of Rows, # of DropBoxes, # of Data Files, and whether or not the Matrix is enabled.

 

Creating Matrices

 

To create a new matrix, select and then right-click the Matrices node in the tree view navigation pane and choose Add New Matrix from the context menu.  At a minimum you need to supply a unique matrix name.  Creating a matrix automatically launches the matrix editor for further customization. 

 

Editing Matrices

 

To edit a matrix, select the matrix node in the tree view navigation pane to open the matrix editor in the context pane. 

 

Matrices have the below attributes which can be modified through the editor via the Information area:

Matrix Name: The friendly name and caption for the matrix that will appear in the navigation tree view pane and via external interfaces in pasPortal.

Data File Retention Period: The number of days that files in the matrix will be retained, based on the date the file was submitted, before automatic maintenance removes them.  The default is 0 which designates an unlimited retention period.

Data File Storage Limit (MB): The amount of space (specified in megabytes) of data that may be entered into a matrix before further files are rejected.  The default value is 0 which indicates no maximum size.

File Auto-Extraction Account: The mail account to automatically extract file attachments from and post to the database using settings configured via the pasPortal matrix configuration UI.  This functionality requires that a job be configured that has a Message impeller and Auto-Extraction job step contained within.

Enabled: By default, a matrix is not enabled and must manually be enabled for it to be externally visible to an application via web services or be able to fire impellers.  If a matrix is not enabled, it cannot have impellers trigger jobs or be exposed outside of the pasUnity UI.

FTP Enabled: By default, a matrix is not published via FTP and must manually be enabled for it to be externally visible to FTP clients.  In order to access a matrix via FTP this option must be checked and an Agent must also be configured to publish matrices via FTP as well.  See the Agent topic for details on how to configure the FTP server.

After making changes, be sure to press the Update button to save your changes.

Matrix Design

The Design tab has a limited editor which only allows you to add, remove, and rename columns, rows, and DropBoxes to a Matrix grid. 

 

NOTE: Advanced design and configuration of a Matrix can be done using the pasPortal hosted graphical designer and configuration tools.

Create Column: To add a column right-click inside the left hand pane and select Create Column... from the context menu.  You will be prompted to enter the name of the column.  Column names must be unique.  New columns are added to end of the grid.

Rename Column: To rename a column right-click on the column name and select Rename Column... from the context menu.  You will be prompted to enter the new name of the column.  Column names must be unique.

Delete Column: To delete a column right-click on the column name and select Delete Column... from the context menu.  You will be asked to confirm that you want to delete the column.  Deleting a column will result in the permanent deletion of all DropBoxes in that column.  All data and files stored in the DropBoxes will be permanently deleted.  It is not possible to undo the deletion of a column.  Deleting columns and DropBoxes may result in the failure of impellers or job steps that reference the deleted column.  This function should be used with caution.

Create Row: To add a row right-click inside the left hand pane and select Create Row... from the context menu.  You will be prompted to enter the name of the row.  Row names must be unique.  New rows are added to end of the grid.

Rename Row: To rename a row right-click on the row name and select Rename Row... from the context menu.  You will be prompted to enter the new name of the row.  Row names must be unique.

Delete Row: To delete a row right-click on the row name and select Delete Row... from the context menu.  You will be asked to confirm that you want to delete the row.  Deleting a row will result in the permanent deletion of all DropBoxes in that row.  All data and files stored in the DropBoxes will be permanently deleted.  It is not possible to undo the deletion of a row.  Deleting rows and DropBoxes may result in the failure of impellers or job steps that reference the deleted row.  This function should be used with caution.

Add DropBox: To add a DropBox, right-click in the intersection of a column and a row that does not already have a DropBox and select Add DropBox from the context menu.

Remove DropBox: To remove a DropBox right-click in the intersection of a column and a row that contains a DropBox and select Remove DropBox... from the context menu.  You will be asked to confirm that you want to delete the DropBox.  Deleting a DropBox will permanently delete all data and files stored in the DropBox.  It is not possible to undo the deletion of a DropBox.  Deleting a DropBox may result in the failure of impellers or job steps that reference the deleted DropBox.  This function should be used with caution.

Upload File: To upload a file to a DropBox right-click the intersection of a column and a row that contains a DropBox and select Upload File... to open a file browser dialog.  Only a single file can be uploaded at a time.

The date can be changed by clicking on the date drop-down menu.  Matrix DropBoxes are color coded:

Gray indicates the absence of a DropBox.

White indicates a DropBox that has no content.

Green indicates a DropBox that contains processed files.

Yellow indicates a DropBox has work queued or in progress for uploaded files.

Red indicates a DropBox that contains at least one failed file.

Matrix DropBoxes also display a summary of the number of successfully processed files (S), failed files (F), and total files (T).  For example, if a DropBox contained one success, one failure, and one results file the cell would display S:1 F:1 T:3.

 

Clicking inside a DropBox will display an editor in the right side pane to change basic DropBox attributes and override global Matrix settings as well as display a listing of the files contained within the DropBox.  This listing can be used to review file details, remove files from the DropBox, reprocess files, or save files locally. 

 

The following are editable attributes of DropBoxes:

Data File Retention Period Override: If the box is checked you can supply the number of days that files in the matrix will be retained before automatic maintenance removes them.  The default is 0 which designates an unlimited retention period.  If the box is not checked the Data File Retention Period value defined at the Matrix will be used.

Allow Multiple Uploads: When checked the DropBox will allow multiple files to be stored for a single calendar date.

Prevent Duplicate Names: When enabled this will prevent files that have duplicate names from being loaded into the DropBox on the same calendar date.  It does not validate file contents and names are not case sensitive.  This option has no effect if the Allow Multiple Uploads option is not checked.

Reviewing Activity

 

Selecting the Activity tab will show all files, sorted by date, that have been loaded into the matrix and those data files will be color coded to indicate the status of jobs that the data files may have impelled.

 

Reference Monitoring

 

The Monitors tab displays all the impellers throughout the entire system that are configured to monitor the selected matrix.  This allows you to asses the impact of changes to the selected matrix.

Matrix Permissions

 

The Permissions tab will only be visible if pasPortal Integrated Security is enabled during System Configuration.  For a detailed list of the available permission types available at this level refer to the Permissions topic.

Deleting Matrices

 

To remove a matrix, select and then right-click the matrix node in the tree view navigation pane and choose Delete to remove the matrix permanently from the database and the user interface.  This will remove all DropBoxes, data files, history, and work for the matrix selected.

 

Mass Processing Data Files

 

To process multiple data files at a time, select and then right-click the matrix node in the tree view navigation pane and choose Process Data Files to launch the Data File Processing Wizard.

 


Copyright © 2024 pasUNITY, Inc.

 

Send comments on this topic.