Please note: A PDF version of this guide is available for download at the bottom of the article.
This manual details the ARC-specific configurations available under ARC Assistant > Review Board Administration.
System Setup
On the System Setup tab of Review Board Administration, you can configure many aspects of ARC, from setting up animal facilities to configuring notifications.
Review Board System Setup
Setup Order Status
The ARC Order Status screen displays a listing of the ARC order statuses in the system. There are several hard-coded order statuses: Draft, New Response, Pending Approval, Approved for Ordering, Ordered – Pending Receipt, In Quarantine, Completed and Denied.
You can see the name of the status in the Order Status column. The Order Status Queue column displays the queue in which an order with the corresponding status will be placed under ARC Assistant > Orders. For example, you can find orders with a status of “New Request” in the “Approved for Ordering” queue.
Click the icon in the Edit column to view the details of an order status.
Because this status is hard-coded, you will only be able to change the Sort Order and the associated color. The Sort Order controls the order of the list of statuses, both on the ARC Order Status screen and when the statuses appear in a dropdown list (for example, if you are adding a status in the order form’s workflow). When you are finished making any changes, click Save the project status.
Setup Order Numbering
This feature is used to set up automated numbers for animal orders. This is where you will configure the auto-generated order number sequencing.
To set up variables in automated order numbers, check the box in the Use in Number column. In this case, Constant Prefix, Calendar Year, and System Generated Number are being used to create the order number. These are listed in the second column, Description of Number Part. The next column, Number Part Information, is where data values are given to the auto-generated number. The last column, Separator, specifies which separator to use between the chosen number parts.
The Constant Prefix will begin all animal orders with the prefix specified under Number Part Information. It will be followed by a separator (-), as indicated in the Separator column. The Calendar Year will use the year, displaying either all four digits, or only the last two, depending on which is selected. The last row indicates that a System Generated Number will be used. The first text box is used to specify where the number should begin. Check “Zero Pad the Sequence Number” to add zeroes to the system-generated number. The selected number will increase each time a new order number is created. The Number of Digits specified indicates how many digits will be used. In this case, the auto- generated number will start at ORD-17-071, and increase one digit each time a new order is created, e.g. ORD-17-072, ORD-17-073, and so on. When you are finished configuring your numbering, click the Save Numbering button.
Setup Transfer Numbering
This feature is used to set up automated numbers for animal transfers. This is where you will configure the auto-generated transfer number sequencing.
To set up variables in automated transfer numbers, check the box in the Use in Number column. In this case, Constant Prefix, Calendar Year, and System Generated Number are being used to create the transfer number. These are listed in the second column, Description of Number Part. The next column, Number Part Information, is where data values are given to the auto-generated number. The last column, Separator, specifies which separator to use between the chosen number parts.
The Constant Prefix will begin all animal transfers with the prefix specified under Number Part Information. It will be followed by a separator (-), as indicated in the Separator column. The Calendar Year will use the year, displaying either all four digits, or only the last two, depending on which is selected. The last row indicates that a System Generated Number will be used. The first text box is used to specify where the number should begin. Check “Zero Pad the Sequence Number” to add zeroes to the system-generated number. The selected number will increase each time a new order number is created. The Number of Digits specified indicates how many digits will be used. In this case, the auto- generated number will start at TRN-17-033, and increase one digit each time a new order is created, e.g. TRN-17-044, TRN-17-045, and so on.
Setup Facilities/Floors/Rooms
This menu option will allow you to configure the facilities where your animals will be housed. You can set up facilities and then define floors and rooms for animal housing.
When you open the Setup Facilities/Floors/Rooms screen, you may see a list of facilities that have already been configured in your system. Click Add a New Facility to add a new facility record to the system. When the new screen opens, the only section initially visible is the Facility section. In this section, the only required field is the Facility Name.
You can also enter a Facility Code and the address for the facility. Once you have entered the facility information, click the Save Facility button. This will populate the Facility Floors and Facility Rooms sections of the screen.
To add a floor to the facility, click the Add Floors button. The Setup Floor pop-up window will open, allowing you to enter a floor in the Floor field.
Click Save Floor to add the floor to the facility.
To add a room to the facility, click Add Rooms. The Setup Room pop-up window will open.
In this window, Room (room number) and Room Size (Sq. Ft.) are required fields. You can also enter information in the Room Use and Room Description fields. You will need to set the Quarantine Use flag to Yes if you wish the room to be designated for quarantined animals. You can also select between Active and Inactive in the Room Status dropdown menu. When you are finished entering details for the room, click Save Room.
To delete a floor or room that has already been created, check the box next to the record and click the corresponding Delete button (Delete Rooms or Delete Floors).
When you are finished setting up your facility, floors, and rooms, click Save Facility Changes, and then click Back to return to the previous screen.
To view an existing facility, click the icon in the Edit column. You will be brought to a screen listing the facility and its associated floors and rooms.
When editing a facility, you can add or edit facility information, floors, and rooms as described above. Be sure to click Save Facility Changes when you are finished editing.
To delete an existing facility or multiple facilities, check the box(es) next to the record(s) and click Delete Selected Facilities.
Setup Cage Status
The Setup Cage Status menu option allows you to view the hard-coded cage statuses in your system.
You will see four hard-coded options on this screen: Active, Quarantine, Retired, and Transfered. The “Yes” in the Reserved column indicates that these origin types are hard-coded and cannot be deleted or edited.
Setup Cage Types
When setting up cage types in ARC, you can define the associated species, the size of the cage, the maximum number of animals per cage, and whether to calculate per diem by cage or by animals per cage. When you first open the Setup Cage Types menu item, if cage types have already been created in your system, you will see the table of existing cage types.
To add a new cage type, click the Add a New Cage Type button.
The fields on this screen are as follows:
Cage Type: Enter the name of your new cage type in this text field.
Species: You can select from the species configured in your system from this dropdown list.
Cage Size: Enter the cage size here.
Max. Animals Per Cage: Enter a numerical value here representing the maximum number of animals the cage can hold.
Per Diem By: In this dropdown menu, select from between Cage and Animal. When Cage is selected, the per diem rate for the cage type will be one standard rate, regardless of the number of animals housed in the cage. When Animal is selected, the per diem rate will be calculated according to the number of animals in the cage.
When you are finished entering information, click Save Type to return to the previous screen.
To edit an existing cage type, click the icon in the Edit column. You will be able to edit the fields described above.
Remember to click Save Type when you are finished.
To delete an existing cage type(s) from the main page of cage type records, check the box(es) next to the cage type(s) you wish to delete and click Delete Cage Type(s). A pop-up will display, asking you to confirm the deletion. Click OK to proceed or Cancel to return without deleting.
Setup Cage Card Template
When you first open the ARC – Review Board Cage Card Template screen, you will see a list of the cage cards, if any, that have already been created in the system.
To add a new cage card template, click the Add a New Template button. You will be brought to a screen where you can set up the template. The Microsoft Word editor on this screen is a plug-in that is only available in Internet Explorer.
Enter a Title for your template and any comments, if desired. You can edit the cage card template using the features of the editor and by inserting merge codes, which will pull in information when the cage card is generated. Position your cursor where you would like the merge code to be inserted, and click the Insert Merge Codes button. The Insert Data Merge Code window will open, as shown below.
Select the merge code you wish to insert, and click OK. The merge code will be added to the document in the location where you placed your cursor.
In the example given above, the merge code will populate with the actual name of the species in the cage when the cage card is generated.
Click the Barcode Settings button if you wish to change the size and/or position of the barcode on your cage cards.
You can grab the barcode with your mouse and pull it to the desired location on the card. Click and drag the arrow in the barcode’s lower right-hand corner to resize the barcode. If you would like to move the barcode back to its original location before you have saved, click Reset Bar Code. To save the barcode’s position on the card and return to the previous screen, click Save.
When you are finished editing your cage card template, click the Save the Letter Template button.
After returning to the main list of cage card templates, click the icon in the Edit column to open and edit an existing template. To delete template(s), check the box(es) next to the desired template(s) and click the Delete Selected Template(s) button.
Setup Per Diem Definitions and Rates
The Setup Per Diem Definitions and Rates menu option allows you to define per diem effective dates and rates for the different types of cages in your system. If any per diem dates have already been defined, you will see them in a table listing the Cage Type, Description, Per Diem Code, Effective Date, and Rate.
Click Add a Rate to set up a new per diem rate in the system.
When defining a per diem rate, you will be able to enter the following information:
Cage Type: In this dropdown menu, select from the cage types configured in the system. You should not select a cage type that already has a per diem rate configured.
Per Diem Code: Enter the code in this text field.
Description: Enter the description in this text field.
Effective Date: Enter the date here on which you would like per diem collection to begin.
Rate: Enter the daily rate here. When per diem is calculated for a cage, this rate may be applied per animal or per cage, depending on your system configurations.
If your per diem rates change over time, you may want to add a new rate that will start on a different date than the initial date you set up. Click Add a new Rate Details. This will create a new record in which you can add the date the new rate becomes effective as well as the new rate.
Add the new Effective Date and Rate, and click Save Per Diem Rate. As seen in the screenshot below, the ending date for the first per diem rate will be populated with the day before the new rate begins.
In this case, the rate will be $5.00 a day from 1/10/2017 through 1/31/2017. On 2/1/2017, the rate will increase to $6.00/day.
Click Save Per Diem Rate to save the changes you have made and click Back to return to the previous screen. The new rate you have added will appear in the table of results.
To edit an existing rate, click the icon in the Edit column. To delete an existing rate(s), check the box(es) next to the corresponding record(s) and click Delete Selected Rate(s).
Setup Veterinarian Profile
Under Setup Veterinarian Profile, you can designate users from the iRIS system as veterinarians. Animal internal transfers typically include a signoff by a veterinarian as a part of their workflow.
When you first open the page, a list of any veterinarians already designated in the system will populate.
The table of results lists the veterinarian’s first and last name, employee ID, phone number, and email address. If you have multiple veterinarians in your system, you can select the Default radio button next to a name to designate the vet who will automatically populate in your transfer forms.
To define a new veterinarian profile, click the Add a New Profile button. The Search User window will open, allowing you to search the iRIS directory. Enter all or part of the user’s name in the Last Name and First Name fields. You can also narrow down your results by selecting a Site from the dropdown list.
Once you have identified the user you would like to add as a veterinarian, click the icon next to their name in the Select column. A view of the user’s profile will display, as seen below.
Click Save Profile, and the user will be added to the list of veterinarian profiles.
Click the icon in the Edit column to view a veterinarian’s user profile. To delete veterinarian profile(s), click the box(ex) next to their name(s) and click Delete Selected Profile(s).
Setup Transfer Coordinator Profile
Under Setup Transfer Coordinator Profile, you can designate users from the iRIS system as Transfer Coordinators. Animal internal transfers typically include a signoff by a Transfer Coordinator as a part of their workflow.
When you first open the page, a list of any Transfer Coordinators already designated in the system will populate.
The table of results lists the coordinator’s first and last name, employee ID, phone number, and email address. If you have multiple Transfer Coordinators in your system, you can select the Default radio button next to a name to designate the user who will automatically populate in your transfer forms.
To define a new Transfer Coordinator profile, click the Add a New Profile button. The Search User window will open, allowing you to search the iRIS directory. Enter all or part of the user’s name in the Last Name and First Name fields. You can also narrow down your results by selecting a Site from the dropdown list.
Once you have identified the user you would like to add, click the icon next to their name in the Select column. A view of the user’s profile will display, as seen below.
Click Save Profile, and the user will be added to the list of Transfer Coordinator profiles.
Click the icon in the Edit column to view a Transfer Coordinator’s user profile. To delete Transfer Coordinator profile(s), click the box(ex) next to their name(s) and click Delete Selected Profile(s).
Setup Generation
When you open the Setup Generation menu item, you will see a list of hard-coded generations already in the system. You will notice that the hard-coded generations do not have a checkbox to be deleted and say “Yes” in the Reserved column. You will not be able to make any edits to the hard-coded generations.
Click Add a New Generation to create a custom generation. This will bring you to a screen where you can enter the name in the Generation field.
After entering the name, be sure to click Save Type.
Setup Life Status
When you open the Setup Life Status menu item, you will see several hard-coded statuses already in the system: Alive, Dead, Euthanized, Killed, Missing, Transferred, and Shipped.
Click the icon in the Edit column to view the details of a life status.
The fields on this screen are as follows:
Life Status: Here, you can edit the name of the status.
Color: You can pick a color from the array of colors to represent the status.
Allow Edits: A “Yes” flag in this field indicates that you will be able to edit the animal’s record under Animal Management for a study.
Animal in Use: This flag determines whether an animal with this status will be counted when per diem is collected.
If you have made any edits to the life status, be sure to click the Save Type button, which will return you to the previous screen.
Click Add a New Life Status to add a custom status. You will be brought to the same screen as detailed above, with the ability to name the Life Status, set the color, and set values for the Allow Edits and Animal in Use flags. Click Save Type when you are done configuring the life status to save and return to the previous screen.
On the main page listing life statuses, note that the hard-coded statuses say “Yes” in the Reserved column. This indicates that these are hard-coded and cannot be deleted. If you have added a custom life status, you will see a checkbox in the first column in the table. Check the box and click Delete Life Status(es) to delete the status.
Setup Coat Color
The Setup Coat Color menu option allows you to configure coat colors for animals that can be selected in the animal’s profile.
Click Add a New Coat Color to configure a new coat color for a species.
First, select a Species from the dropdown menu, which contains the list of species configured in your system. Next, select a Coat Color from the dropdown menu. Click Save Type to save the new coat color and return to the previous screen.
To edit an existing coat color, click the icon in the Edit column. This will open the screen shown above, where you can edit the Species and Coat Color. Be sure to click Save Type to save your edits when you are done.
To delete existing coat color(s), check the box(es) next to the corresponding record(s) in the table of coat colors and click Delete Coat Color(s).
Setup Diet
The ARC – Setup Diet page displays any diets for species that have already been configured in your system. An animal’s diet can be added to its profile.
Click Add a New Diet if you wish to add a new diet to the system.
On this screen, you can select a Species from the dropdown list of species configured in your system. Enter the name of the new diet in the Diet text box. When you are finished, click Save Diet to save your changes and return to the previous screen. The new diet you have added will appear in the list of records.
To edit a diet, click the icon in the Edit column. To delete diet(s), check the box(es) next to the corresponding record(s) and click Delete Diet(s).
Setup Plug Use Type
When you first open the Setup Plug Use Type menu option, you will see a list of plug use types, if any, that have already been created in your system.
Click Add a New Plug Use Type to add a new record to the list. On the next screen, you will first be prompted to select a Species from a dropdown menu of all the species configured in your system. In the Plug Use Type field, enter the name of the plug use type.
Click Save Plug Use Type to save the information you have entered and return to the previous screen.
To edit an existing plug use type, click the icon in the Edit column. You will be brought back to the screen shown above and can edit the Species and Plug Use Type fields.
To delete an existing plug use type, select the checkbox next to the corresponding record and click Delete Plug Use Type(s).
Setup Origin Type
The Setup Origin Type menu option allows you to view the origins for animals, or the way they were added to a study (i.e., order, transfer, breeding).
You will see four hard-coded options on this screen: Order, Internal Transfer, External Transfer, and Breeding. The “Yes” in the Reserved column indicates that these origin types are hard-coded and cannot be deleted or edited.
Setup Observation Diagnosis
Observation diagnoses can be used when you are creating a new observation about an animal in the animal’s profile.
To add a new observation diagnosis, click the Add a New Diagnosis button. You will be brought to a screen where you can enter a Diagnosis in the corresponding text box.
After entering information, click Save Diagnosis to save and return to the previous screen.
To delete a diagnosis, check the box(es) next to the record(s) you wish to delete and click Delete Diagnosis.
You can select an Observation Diagnosis when adding an observation about an animal in Animal Management.
Setup Observation Outcome
Observation outcomes can be used when you are creating a new observation about an animal in the animal’s profile.
To add a new observation outcome, click the Add a New Outcome button. You will be brought to a screen where you can enter an Outcome in the corresponding text box.
After entering information, click Save Outcome to save and return to the previous screen.
To delete an outcome, check the box(es) next to the record(s) you wish to delete and click Delete Outcome.
You can select an Observation Outcome when adding an observation about an animal in Animal Management.
Setup Observation Treatment
Observation treatments can be used when you are creating a new observation about an animal in the animal’s profile.
To add a new observation treatment, click the Add a New Treatment button. You will be brought to a screen where you can enter a Treatment in the corresponding text box.
After entering information, click Save Treatment to save and return to the previous screen.
To delete a treatment, check the box(es) next to the record(s) you wish to delete and click Delete Treatment.
You can select an Observation Treatment when adding an observation about an animal in Animal Management.
Setup Breeding Status
The breeding status is added to a breeding record on a study to indicate the status of the animals that were born. When you first select the Setup Breeding Status menu option, you will see a list of any breeding statuses that have already been set up in your system.
To add a new status, click the Add a New Breeding Status button. On the following screen, enter a new status in the Breeding Status field.
Click Save Breeding Status to save the status and return to the previous screen.
To edit an existing breeding status, click the icon in the Edit column. You will be brought to the screen where you can edit the name of the breeding status as shown above. Click Save Breeding Status to retain your edits and return to the previous screen.
You can select a breeding status when creating a breeding record, as shown below.
Setup Breeding Type
You can select a breeding type when you are setting up a breeding record in a study. Clicking the Setup Breeding Type menu item will bring you to the list of breeding types that have already been set up in your system.
To add a new status, click the Add a New Breeding Type button. On the following screen, enter a new type in the Breeding Type field.
Click Save Breeding Type to save and return to the previous screen.
To edit an existing breeding type, click the icon in the Edit column. You will be brought to the screen where you can edit the name of the breeding type as shown above. Click Save Breeding Type to retain your edits and return to the previous screen.
You can select a breeding type when creating a breeding record, as shown below.
Setup Gene
Genes are used when defining an animal’s genotyping under Animal Management. When you first open the Setup Gene menu item, you will be presented with a list of genes that have already been defined in your system, if any.
To add a new gene, click the Add a New Gene button. On the following screen, enter the gene name in the Gene field.
Click Save Gene to save your entry and return to the previous screen.
To edit an existing gene, click the icon in the Edit column. You will be brought to the screen where you can edit the name of the gene as shown above. Click Save Gene to retain your edits and return to the previous screen.
You can select a gene when setting up an animal’s genotype, as shown below.
Setup Allele
Alleles are used when defining an animal’s genotyping under Animal Management. When you first open the Setup Allele menu item, you will be presented with a list of alleles that have already been defined in your system, if any.
To add a new allele, click the Add a New Allele button. On the following screen, enter the allele name in the Allele field.
Click Save Allele to save your entry and return to the previous screen.
To edit an existing allele, click the icon in the Edit column. You will be brought to the screen where you can edit the name of the allele, as shown above. Click Save Allele to retain your edits and return to the previous screen.
You can select an allele when setting up an animal’s genotype, as shown below.
Review Board Notification Setup
You can configure review board notifications that will email specified users within the system based on system actions.
Notifications can all be set up in the same way, by entering the content of the email and using merge codes to pull in specific information. Start by clicking the Add Notification button.
All notifications will require a Title. This will be the subject line of the email.
You can specify whether to send the email notification by selecting Yes or No in the Send E-Mail Notification column. If “Yes” is set, the notification will send to the recipient. If “No” is set, the notification will not send via email. However, the recipient of the notification should still receive a home screen task and the notification can still be tracked within the system.
Within the E-Mail Content portion of the notification, you can enter the body of the email. You can type in or copy and paste text and use the system’s merge codes to pull in specific information when the notification is generated. Click the Insert Merge Code button and a small pop-up window will open, allowing you to select the merge code you wish to use.
For example, if you wanted the notification to populate with the name of the PI when the email is sent, you could select a Principal Investigator Name merge code.
Once a notification is added, the record will update with information related to how the notification was configured. The notification can be deleted, if necessary by clicking on the Delete Notification button. If you delete the notification, you can re-add the notification, but none of the information you previously added to the notification will be kept.
Internal Transfer Originating PI Signoff Notification Setup
The notifications in this category are related to signoffs by the originating PI (from the study supplying the animals) on internal animal transfers.
Internal Transfer Originating PI Signoff Notification
This notification is sent to the Principal Investigator of a study when an internal animal transfer has been initiated from another study.
Internal Transfer Originating PI Signoff Denial Notification
This notification is sent to the Principal Investigator of a study when an internal animal transfer request has been denied by the originating PI.
When the originating PI denies the transfer request, a Submission Signoff Denied home screen task also generates.
Click the icon in the open column to view the details of the signoff denial. From this screen, you can click the link to view the transfer from, open the study to make a correction and re-submit your request, or simply remove the item from your task list on your home screen.
Internal Transfer Originating PI Signoff Reminder Notification
This notification is generated to remind the originating PI that they have an outstanding internal transfer request. You can specify in the notification how frequently you would like this notification to generate by defining a number of days. For example, if you enter “2” in the “Notify every ? Days” field, the originating PI will receive a notification every two days.
Internal Transfer Originating PI Signoff Exceeded Notification
This notification is generated and sent to the originating PI a specified number of days after the initial internal transfer signoff notification has been sent. You can indicate the number of days when setting up the notification. For example, a value of “5” in the “Notify when signoff has not been completed within ? Days” field means that this notification will generate five days after the original notification if the signoff has not yet been completed.
Internal & External Transfer Coordinator Signoff Notification Setup
The notifications in this category are related to signoffs by the Transfer Coordinator on internal and external animal transfers.
Internal & External Transfer Coordinator Signoff Notification
This notification is sent to the designated Transfer Coordinator when they have been assigned to sign off on an internal or external animal transfer.
Internal & External Transfer Coordinator Signoff Denial Notification
This notification is sent to the PI of a study when an internal or external animal transfer has been denied by the Transfer Coordinator.
When a transfer is denied, the PI of the study requesting the animals will also receive a Submission Signoff Denied home screen task, as described earlier in the manual.
Internal & External Transfer Coordinator Signoff Reminder Notification
This notification is generated to remind the Transfer Coordinator that they have an outstanding internal or external transfer request. You can specify in the notification how frequently you would like this notification to generate by defining a number of days. For example, if you enter “2” in the “Notify every ? Days” field, the Transfer Coordinator will receive a notification every two days.
Internal & External Transfer Coordinator Signoff Exceeded Notification
This notification is generated and sent to the Transfer Coordinator a specified number of days after the initial internal transfer signoff notification has been sent. You can indicate the number of days when setting up the notification. For example, a value of “5” in the “Notify when signoff has not been completed within ? Days” field means that this notification will generate five days after the original notification if the signoff has not yet been completed.
Internal & External Transfer Veterinarian Signoff Notification Setup
The notifications in this category are related to signoffs by the veterinarian on internal and external animal transfers.
Internal & External Transfer Veterinarian Signoff Notification
This notification is sent to the designated veterinarian when they have been assigned to sign off on an internal or external animal transfer.
Internal & External Transfer Veterinarian Signoff Denial Notification
This notification is sent to the PI of a study when an internal or external animal transfer has been denied by the veterinarian.
When a transfer is denied, the PI of the study requesting the animals will also receive a Submission Signoff Denied home screen task, as described earlier in the manual.
Internal & External Transfer Veterinarian Signoff Reminder Notification
This notification is generated to remind the veterinarian that they have an outstanding internal or external transfer request. You can specify in the notification how frequently you would like this notification to generate by defining a number of days. For example, if you enter “2” in the “Notify every ? Days” field, the veterinarian will receive a notification every two days.
Internal & External Transfer Veterinarian Signoff Exceeded Notification
This notification is generated and sent to the veterinarian a specified number of days after the initial internal transfer signoff notification has been sent. You can indicate the number of days when setting up the notification. For example, a value of “5” in the “Notify when signoff has not been completed within ? Days” field means that this notification will generate five days after the original notification if the signoff has not yet been completed.
System Administration
Under System Administration > System Configuration > Animal Resource Center, there are four properties that allow you to determine how certain aspects of the ARC order and transfer forms are configured:
system.use_arc_foundation – This property controls whether the Foundation field appears in the Funding section of an animal order or transfer form.
system.use_arc_requisition – This property controls whether the Requisition field appears in the Funding section of an animal order or transfer form.
system.use_arc_study_accounts – When this property is set to “Yes,” instead of a field where you can type in the Order Charge Account, a dropdown menu will appear in this field containing the cost centers that have been set up for the study. Cost centers are created under Study Management > Finance Set-up > Study Accounts.
system.use_arc_unique_anatomical_features – This property controls whether the Unique Anatomical Features/Phenotype field appears on an animal order or transfer form.
© iMedRIS Data Corporation