To manage your resource allocation processes, there is a minimum set of data that XRAS needs to know. At the moment, you will need to provide some of this information to the XRAS team, but we are working to provide interfaces that will allow you to enter and edit these values. You will find most of these interfaces by selecting “Client Settings” “Client Settings” under the XRAS gear menu.
...
The following data must be provided to the XRAS team to spin up your instance of XRAS. You can customize these aspects of XRAS for your site, or you may choose to use the values used by XSEDEACCESS.
Initial Allocation Administrator (required). When first configuring XRAS, you must designate someone from your organization to be an Allocation Admin. Once that person has been given administrative access to XRAS Admin, they can grant admin access to others.
Allocations Process and Client information (required). Your institution’s name; your preferred abbreviation for your institution; your institution’s logo; your institution’s contact help email. The abbreviation is displayed on the Submit, Review, and Admin interfaces and used in the default URLs (https://orgAbbrev-submit.xras.xsede.org, https://orgAbbrev-review.xras.xsede.org, https://orgAbbrev-admin.xras.xsede.org). Even if hosting your own submit interface, we will still create and host Review and Admin sites for you.
Action Types. The set of transactionsactions with which users make requests or manage their allocations. XRAS currently recognizes New new and Renewal renewal requests as well as Transfertransfer, Extensionextension, Supplementsupplement, Appealappeal, and Advance advance actions, as well as Progress Reports and Final Reportsactions to allow researchers to submit progress reports and final reports.
Review Form Fields. You can define the template and field types (text area, calendar, etc.) that your reviewers need to complete when entering a review. You can customize the form per allocation type and action type. You will likely provide these details once you’ve customized XRAS with your allocation types and other details.
Fields of Science. If your institution requires selecting a primary and, optionally, a secondary field of science when submitting a project allocation request, you can provide a custom list and their abbreviations.
Default resource reviewers. You can configure XRAS to speed up the review process of an allocation request by defining default reviewers for requests asking for a given resource. If you are interested in this feature, please contact help@xsedeat allocations@access-ci.org. After a final submission, designated resource default reviewers are automatically assigned to those submissions that requested those particular resources. These reviewers are notified by email when they receive assignments.
...
The following settings can be customized to your site’s preferences by you or another XRAS Admin. These features are available under the XRAS gear menu by selecting “Client Settings.” Further customization can be managed via the Rules interfaces.
Request Number Format
You can customize the format that XRAS uses to generate project numbers for successive submissions. It must at a minimum include a number sequence field. The template may include letters, numbers, underscores '_', dashes '-', and dynamic template fields enclosed by vertical bars '|'. Currently, XRAS allows dynamic prefixes based on the field of science value associated with a submission.
Available template fields
|N| | A number sequence incremented when the rest of the template has been used previously. This is the required field. Multiple Ns may be used to specify padding. |N| would give 1,2,3,4,... |NNNN| would give 0001,0002,..,0123, ... If the year field is used, the number sequence restarts when the year changes. |
|YY| or |YYYY| | The year the request was submitted |YYYY| is the full four-digit year, |YY| is the last two digits. |
|FOS| | The Field of Science abbreviation specified for the request. Only use FOS if Primary Field of Science is a required field for your requests. |
Examples of Request Number Templates
Template | Request number examples |
ABC|N| | ABC1, ABC2, ABC3, ABC4, ... |
ap|YY||NNN| | ap18001, ap18002, … ap19001, ap19002 |
|FOS||YY||NNNN| | CHE180001, PHY180001, CHE180002, PHY190001, etc. |
ORCID Configuration
If your organization is an ORCID member, you can use XRAS to post allocation award information to your users’ ORCID profiles. Using this feature requires several settings to be configuredmanaged.
First In addition, you must separately allow your users to link their local usernames at your site to their ORCID identifiers. You can support the ORCID linking via an external web interface andAt present, this must happen outside of XRAS. You must also send the ORCID tokens to XRAS via the Identity Service API.
NextFirstHere, under the Client Settings, ORCID Configuration, menu, you must enter the information about your organization that is required by ORCID. The information must include a GRID Research Organization Registry or RINGGOLD identifier as well as basic geographic information. If you enter your ORCID client ID and secret here, the default XRAS Submit UI will let users connect their ORCID identities and grant permission to post your allocation awards to the users’ profiles.
Next, you must also use the Rules UI to “Enable Public Request Pages.” You can only post to ORCID allocated projects that have a public page, which XRAS can provide.
Finally, you should also ensure that your resources in XSEDE’s Resource resource is in the Cyberinfrastructure Description Repository (RDRCIDeR) have a public page or other persistent identifier associated with them.
...
To associate resources with a given allocation type, you must configure those settings in the XSEDE Resource Cyberinfrastructure Description Repository (RDRCIDeR). See the RDR CIDeR appendix for instructions.
IMPORTANT: The various interfaces for XRAS may behave unexpectedly if there are no resources associated with an allocation type.
...
You can customize the document types associated with your allocations policies and define which documents are required or optional for each allocation type. The XRAS interface allows the administrator to add and remove document types that can be assigned to various allocation types. The “Display Name” entered for the document will be shown in Submit, Review, and Admin components. (Set documents to be required or optional via the Rules interface for Required/Optional Documents.)
Person Status Types
When creating new users to be associated with an allocation request, a user’s status type (Graduate Student, Faculty, ...) can be selected. You can use these person status types in XRAS rules to define, for example, who is eligible to submit an allocation request. XRAS allows admins to create a comprehensive list of categories a user may fall under, such as “Faculty,” “University Research Staff,” and “Graduate Student.” These values should match those used in your local account management system and passed via the Identity Service endpoints to XRAS.
...
When creating an agreement you can specify the text that the user must agree to, the length of time the agreement is good for (listed in days), and a checkbox that controls if the agreement requirement is active or not.
Custom Review Forms
XRAS provides a user interface to manage customized review forms for use on XRAS Review. These forms allow you to add multiple types of custom questions for reviewers to fill out as part of their review.
...