Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ automation / sisRunJob

  • Article
  • 2 minutes to read

Description

Used to run a job

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
sys.c.manageAutomationJobs
 --- --- ---

Request Parameters

The sisRunJob method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
jobPriority sisJobPriority Optional
Default=medium		 Specify the priority of job to run.
name xs:string Required No description provided
description xs:string Optional No description provided
target xs:anyURI Required Spefify a URN that describes the computer(s) that this job should be run on. For example, to target a specific computer, you should specify ‘computer:DAVEPC01’. To target a list of computers, you can specify ‘list:list_id’.
reference xs:anyURI Optional Specify any reference URN meaningful to the caller.
sisTarget xs:anyURI Optional Specify the Site Integration target. Can either be a group “grp:TheGroupName” or a SIS server directly “sis:SisName”
adminCredentials xs:unsignedInt Optional
Default=0		 Specify the credentials to use for administration tasks when running this job. If not specified, then the credentials that the Site Integration Service is using will be used.
runAsCredentials xs:unsignedInt Optional
Default=0		 Specify the credentials to use for running the process when running this job. If not specified, then the provided adminCredentials will be used.
packageId xs:string Required Specify the package we are running this job from.
operation xs:string Required Specify the operation within the package to run.
earliestStartTime xs:dateTime Optional The earliest date and time at which the job can be run. If not specified, the job will run as soon as possible, subject to any other constraints.
latestStartTime xs:dateTime Optional The latest date and time at which the job can be run. If specified, if the job cannot be run by this time, it is automatically failed. If not specified, the job will remain queued until it can be started successfully.
param sisJobInputParameterType Optional
Array (0/∞)		 The input parameters required by the package in order to run the job.
extraCredentials sisExtraCredentialType Optional
Array (0/∞)		 The extra credential required by job

Response Parameters

Name Type Attributes Description
job sisJobResultInfoType Required Information about the job.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document