Cprime Apps has been rebranded as Anova Apps. Please note the only effect is the company name - all of our products’ names, logos, functionalities, support, etc. is exactly the same. The new location to our documentation space is https://anovaapps.atlassian.net.
The section contains routines that enable users to set up "template" projects in your Jira.
You need to have administrator rights to run them and you need to take care when updating your projects.
Following simple example shows how you can mess the Jira install: you have an existing project, several issue types, and you set up a new issue type scheme which does not contain all the issue types previously in the project. The result is undefined, and most probably Jira will complain and / or will throw exceptions because the set issue type scheme routine does not migrate the existing issues with non-existent types.
Routines summary
- admActivateUser — Activates a user, setting its active flag to 'true', if update is allowed.
- admAddCustomFieldAlias — Adds a custom field alias in the sil.aliases file.
- admAddCustomFieldOption — Adds a new custom field option to options list for the specified context. If the context does not exist, it will be created.
- admAddFieldToScreen — Adds a field(custom field or system field) to a screen.
- admAddGroupsToGroup — Add the provided groups to the specified groups if they are not already added.
- admAddGroupToProjectRole — Adds a single group to a project role if the group is not already in that role.
- admAddProjectCategory — Adds new project category.
- admAddProjectComponent — Adds a component in the project.
- admAddProjectVersion — Adds a version in the project
- admAddScreenToTransition — Sets the screen for a workflow transition.
- admAddUserToGroup — Adds a single user to a group if the user is not already in that group.
- admAddUserToProjectRole — Adds a single user to a project role if the user is not already in that role.
- admArchiveProject — Archives a project.
- admArchiveProjectVersion — Returns empty string(not relevant).
- admChangeFilterOwner — Changes the ownership of an existing filter.
- admClearCache — Clears the internal cache.
- admClearLinksCache — Clears the issue links cache.
- admCreateCustomField — Creates a new custom field, offering support also for setting its context and searcher.
- admCreateGroup — Create a single group to a project role if the group does not already exist.
- admCreateProject — Creates a new project, optionally offering support for category of the project
- admCreateProjectWithSharedConfiguration — Creates a new project, optionally offering support for category of the project.
- admCreateScreen — Creates a new screen.
- admCreateUser — Creates a new user.
- admDeactivateUser — De-activates a user (sets its active flag to 'false' or removes it from all groups associated to global login permissions).
- admDeleteCustomFieldOption — Delete an option from the options list for the specified context.
- admDeleteFilter — Deletes the filter with the specified id.
- admDeleteProjectComponent — Deletes a component from the project.
- admDeleteProjectVersion — Deletes a project version from a project. The version is also removed from any issues assigned to the version.
- admGetAllFilters — Retrieves all the filters available on the current instance.
- admGetAllIssueTypeSchemes — Returns the list of Issue Type Scheme names that exist in the Jira environment.
- admGetAllIssueTypeScreenSchemes — Returns the list of Issue Type Screen Scheme names that exist in the Jira environment.
- admGetAllNotificationSchemes — Returns the list of Notification Scheme names that exist in the Jira environment.
- admGetAllOwnedFilters — Retrieves a list with all the filters owned by a user.
- admGetAllPermissionSchemes — Returns the list Permission Scheme names that exist in the Jira environment.
- admGetAllPrioritiesScheme — Returns the list Priority Scheme names that exist in the Jira environment.
- admGetAllProjectCategories — Get the names of all project categories.
- admGetAllScreens — Returns the list Screen names that exist in the Jira environment.
- admGetAllScreenSchemes — Returns the list Screen Scheme names that exist in the Jira environment.
- admGetArchivedProjects — Gets all projects that have been archived.
- admGetContextualScreenFields — Retrieves the available fields for the user in the given context (screen/project/issue type)
- admGetCustomFieldOptions — Retrieves the option list of a custom field for the specified context (projects and issue types).
- admGetFieldConfigurationScheme — Returns the project field configuration scheme.
- admGetFilterById — Retrieves the filter by its id.
- admGetFilterOwner — Retrieves the filter owner.
- admGetFiltersByName — Retrieves all the filters identified by the specified name.
- admGetFiltersForProject — Retrieves all filters for a given project that the user is allowed to see.
- admGetIssueTypeScheme — Returns the project issue type scheme.
- admGetIssueTypeScreenScheme — Returns the project issue type screen scheme.
- admGetIssueTypesFromScheme — Returns a list of issue types associated to a given issue type scheme.
- admGetNotificationSchemeByName — Retrieves a breakdown of events and notifications for a provided notification scheme.
- admGetPermissionsFromScheme — Retrieves a list of actions and corresponding permissions for a given Permission Scheme.
- admGetPrioritiesFromScheme — Retrieves a list of priorities associated to a priority scheme.
- admGetPriorityScheme — Returns the project priority scheme.
- admGetProjectCategory — Get the project category of the project.
- admGetProjectComponent — Returns a JComponent(id, name, description, lead, defaultAssignee) for a specified project and component name. The JComponent structure is described here https://confluence.cprime.io/display/SIL/Predefined+structure+types#Predefinedstructuretypes-JComponent.
- admGetProjectComponents — Returns the project components (all).
- admGetProjectDefaultIssueSecurityLevel — Returns the project's default issue security level, as set by the scheme.
- admGetProjectIssueSecurityLevels — Returns all the project issue security levels, as set by the scheme.
- admGetProjectIssueSecurityLevelsFor — Returns all the project issue security levels, as set by the scheme, for the specified user.
- admGetProjectIssueSecurityScheme — Returns the project issue security scheme.
- admGetProjectNotificationScheme — Returns the project notification scheme.
- admGetProjectPermissionScheme — Returns the project permission scheme.
- admGetProjectVersion — Returns the project version.
- admGetProjectVersions — Returns the project versions (all).
- admGetProjectWorkflowScheme — Returns the project workflow scheme.
- admGetScreenFields — Retrieves a list of all field information for a provided screen.
- admGetScreenSchemeFromITScheme — Retrieves a list of screen scheme configurations for a particular issue type screen scheme.
- admGetScreensFromScheme — Retrieves a list of screen operations and corresponding screens for a given Screen Scheme.
- admGetUserLogin — Gets the login details for the given user.
- admProjectExists — Returns 'true' if project with provided key exists and 'false' otherwise.
- admProjectProperties — Returns the project properties.
- admReindex — Triggers a re-index for all issues across a Jira instance. Starting with SIL Engine™ 4.0.15 you can also specify an optional useBackgroundReindexing parameter to run re-index in the background.
- admReindexIssue — Triggers a re-index for the issue with the given key.
- admReindexProjects — Triggers a re-index of a Jira instance for the specified projects only.
- admReleaseProjectVersion — Returns empty string(not relevant).
- admRemoveGroup — Removes a group from Jira.
- admRemoveGroupFromGroups — Add the provided groups to the specified groups if they are not already added.
- admRemoveGroupFromProjectRole — Removes a single group from a project role if the group is in that role.
- admRemoveUserFromGroup — Removes a single user from a group if the user is in that group.
- admRemoveUserFromProjectRole — Removes a single user from a project role if the user is in that role.
- admResetUserPassword — Updates the password for a user.
- admSetCustomFieldOptionEnabledState — Updates the enabled/disabled state of a specific custom field option for the specified context. If the context does not exist, it will be created.
- admSetFieldConfigurationScheme — Updates the project field configuration scheme.
- admSetIssueTypeScheme — Updates the project issue types scheme.
- admSetIssueTypeScreenScheme — Updates the project issue type screen scheme.
- admSetPriorityScheme — Updates the project priority scheme.
- admSetProjectCategory — Set project category to the project.
- admSetProjectIssueSecurityScheme — Updates the project issue security scheme.
- admSetProjectNotificationScheme — Updates the project notification scheme.
- admSetProjectPermissionScheme — Updates the project permission scheme.
- admSetProjectVersionReleaseDate — Returns empty string(not relevant).
- admSetProjectVersionStartDate — Returns empty string(not relevant).
- admSetProjectWorkflowScheme — Updates the project workflow scheme.
- admShareFilter — Add shares to a filter based on project, role, group, user.
- admUnArchiveProject — Restores a previously archived project.
- admUpdateCustomFieldOptions — Updates custom field options for the specified context. If the context does not exist, it will be created.
- admUpdateFilter — Update one ore more attributes for the provided filter.
- admUpdateProject — Updates the project properties.
- admUpdateProjectComponent — Updates a project component.
- admUpdateProjectVersion — Updates the version of the project by the id field.
- admUpdateUser — Updates the email, user name, or full name for a given user.
- admWriteAuditLog — Creates an entry in the system audit log.
We started to add these administration routines with katl-commons version 2.5.8. Prior versions do not have the routines in place.