About

You may find that your team’s workflow requires you and your colleagues to open the same type of case repeatedly with many of the fields populated in the same way. If that’s the case and you are using Manuscript On Site or Manuscript On Demand, you may find it helpful to generate a link to a template with those fields pre-populated.

Example

For example, if you wanted to create a template for a case with the project, area, category, assigned to, and body fields pre-populated, you could substitute the appropriate values in this URL:

https://<your_manuscript_URL>.manuscript.com/f/cases/new?command=new&pg=pgEditBug&ixProject=<project-id>&ixArea=<area_id>&ixCategory=<category_id>&ixPersonAssignedTo=<assigned_user_id>&sTitle=<title_of_case>&sEvent=<body_of text>

Any text values that you pass in as parameters (for example, as values for sTitle or sEvent) should be URL encoded.

Once you’ve generated the template link, you and your teammates can bookmark it to access the case template quickly in the future.

Our XML API can help you find the id numbers for different values, and the documentation will help you find the names of the parameters.

Note:  Not all fields are writable using this method. Also, URLs do have length limits. For extensive notes in the case edit field we encourage you to use snippets to manage that content after the new case window is opened as opposed to trying to put everything directly in the URL. This helps with readability as well.

Custom Fields

When using Manuscript, most custom fields may be set with URL-based templates. You’ll need the custom field index value and the name to determine the correct URL parameter. You can get both at the same time in the proper format by clicking “New Case”, then right-clicking on the field and selecting “Inspect Element” in Chrome or the equivalent in your preferred browser. Use the input ID value, which will be of the form <Field index value>_<Field name>. Once again the API can also help you find the custom field information. Once you have the field index and name, set a parameter name using the custom field information you collected above and a value equal to what you want to see in the custom field.

For example, to set a drop-down box to “Dropdown value” and to check a true/false checkbox, you would first inspect these elements. In this case, let’s say the dropdown box has an input element ID of “15_dropdown” and the true/false checkbox of “16_truefalse”. After verifying that “Dropdown value” is a valid value for dropdown boxes, the following additional URL parameters tacked on to the example above should set these fields:

&15_dropdown=Dropdown%20value&16_truefalse=true

Note: as a grammar school teacher always says, spelling and capitalization count!