Initializing and Restoring - Revision history

Craig at 21:57, 8 July 2025

2025-07-08T21:57:01Z

← Older revision		Revision as of 21:57, 8 July 2025
Line 1:		Line 1:
	At times, you may wish to perform initialization, backup or restoration of an Obsidian installation. For example, you may wish to take a known good configuration from a development environment and apply it to a test environment.		At times, you may wish to perform initialization, backup or restoration of an Obsidian installation. For example, you may wish to take a known good configuration from a development environment and apply it to a test environment.

			As of Obsidian 6.3.0, we introduce support for [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/SchedulableJob.Initializable.html annotation based initialization] that leverages our [[Implementing_Jobs#Classpath_Scanning\|classpath scanning]].

	In Obsidian 3.0.0, we introduce support that leverages the [[Embedded_API#SystemRestoreManager_API\|System Restore]] functionality of our API. Both the [[Embedded_API\|Embedded API]] and [[REST_API\|REST API]] expose functions for retrieving and updating the full configuration for an Obsidian installation. Rather than require you to individually retrieve all the configuration items and then apply them elsewhere, a full JSON snapshot can be generated and imported, allowing for easy backups and restores.		In Obsidian 3.0.0, we introduce support that leverages the [[Embedded_API#SystemRestoreManager_API\|System Restore]] functionality of our API. Both the [[Embedded_API\|Embedded API]] and [[REST_API\|REST API]] expose functions for retrieving and updating the full configuration for an Obsidian installation. Rather than require you to individually retrieve all the configuration items and then apply them elsewhere, a full JSON snapshot can be generated and imported, allowing for easy backups and restores.

			== Uses ==

	== ~~Uses~~ ==		=== Annotation Initialization ===
			''As of Obsidian 6.3.0''

			Job configuration can be automated into target environments via via annotations and [[Implementing_Jobs#Classpath_Scanning\|classpath scanning]]. The base annotation to configure a job is [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/SchedulableJob.Initializable.html Initializable]. It is a [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/annotation/Repeatable.html @Repeatable] annotation. On every startup, the nickname in the annotation is used to determine if that job <code>Initializable</code> reference has been initialized before, either via annotation, API or UI. Any nickname conflict will prevent initialization. Initialization is best effort per annotation, with errors logged and event notifications dispatched.

			Chains can be initialized via [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/SchedulableJob.InitializableChainAnnotation.html InitializableChainAnnotation] using nicknames. It is also a [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/annotation/Repeatable.html @Repeatable] annotation. Descriptions along with source and target job are used to determine if the chain has been initialized previously, since source/target pairs can be repeated with different setups. Conditional chaining can be done via [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/SchedulableJob.InitializableChainConditionAnnotation.html InitializableChainConditionAnnotation]. Again, it is a [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/annotation/Repeatable.html @Repeatable] annotation.

	=== Backup or Export ===		=== Backup or Export ===

Craig at 18:41, 9 June 2023

2023-06-09T18:41:51Z

← Older revision		Revision as of 18:41, 9 June 2023
Line 7:		Line 7:

	=== Backup or Export ===		=== Backup or Export ===
	Use the System Restore [[REST_Endpoints#GET_a_system_restore_configuration\|GET REST endpoint]] or the [[Embedded_API#Get_System_Restore_Configuration\|equivalent Embedded API]] to retrieve a [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration]. Store the JSON representation in your backup media.		Use the System Restore [[REST_Endpoints#GET_a_system_restore_configuration\|GET REST endpoint]] or the [[Embedded_API#Get_System_Restore_Configuration\|equivalent Embedded API]] to retrieve a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration]. Store the JSON representation in your backup media.

	=== Transfer or Restore a Configuration ===		=== Transfer or Restore a Configuration ===
Line 24:		Line 24:

	== JSON Configuration Format ==		== JSON Configuration Format ==
	The file format is a JSON serialized version of the [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration] class. Here we will define each configuration item and any special conditions associated with each one. A sample JSON is [[#Sample\|provided]].		The file format is a JSON serialized version of the [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration] class. Here we will define each configuration item and any special conditions associated with each one. A sample JSON is [[#Sample\|provided]].

	=== Jobs ===		=== Jobs ===
	The <code>jobs</code> key has a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/JobSaveRequest.html JobSaveRequest] objects. Each of these represents a configured job in Obsidian. This JobSaveRequest is very much like a [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/JobCreationRequest.html JobCreationRequest] but having two extra attributes to handle the case where a job with the same nickname already exists. The <code>updateAttributes</code> flag is used to determine whether the job attributes (jobClass, recoveryType, pickupBufferMinutes, etc.) will be updated when the job exists. The <code>updateSchedule</code> flag is used to determine whether to apply the current schedule and any additional <code>jobSchedules</code> when the job already exists. If any of the schedules' end dates are in the past, they will be skipped.		The <code>jobs</code> key has a list of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/JobSaveRequest.html JobSaveRequest] objects. Each of these represents a configured job in Obsidian. This JobSaveRequest is very much like a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/JobCreationRequest.html JobCreationRequest] but having two extra attributes to handle the case where a job with the same nickname already exists. The <code>updateAttributes</code> flag is used to determine whether the job attributes (jobClass, recoveryType, pickupBufferMinutes, etc.) will be updated when the job exists. The <code>updateSchedule</code> flag is used to determine whether to apply the current schedule and any additional <code>jobSchedules</code> when the job already exists. If any of the schedules' end dates are in the past, they will be skipped.

	=== Job Chains ===		=== Job Chains ===
	The <code>chains</code> key is a [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/ChainsRequest.html ChainsRequest] that houses a collection of chain configurations and a <code>replaceAll</code> attribute. The replaceAll attribute is used when chains already exist in the system. If chains exist and the flag is not set to true, the existing chains are left as is. If set to true, all existing chains are deleted and the new set of chains are created.		The <code>chains</code> key is a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/ChainsRequest.html ChainsRequest] that houses a collection of chain configurations and a <code>replaceAll</code> attribute. The replaceAll attribute is used when chains already exist in the system. If chains exist and the flag is not set to true, the existing chains are left as is. If set to true, all existing chains are deleted and the new set of chains are created.

	=== Job Conflicts ===		=== Job Conflicts ===
	The <code>conflicts</code> key is similar to the [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/ConflictUpdateRequest.html ConflictUpdateRequest] but it uses job nicknames instead of job IDs. If an empty list is supplied, all chains will be deleted. Note that this is different from a null or missing value.		The <code>conflicts</code> key is similar to the [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/ConflictUpdateRequest.html ConflictUpdateRequest] but it uses job nicknames instead of job IDs. If an empty list is supplied, all chains will be deleted. Note that this is different from a null or missing value.

	=== Users ===		=== Users ===
	The <code>users</code> key has a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/UserSaveRequest.html UserSaveRequest] objects. These are similar to the standard [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/user/UserCreationRequest.html UserCreationRequest], but they contain an <code>update</code> attribute that is used when the user already exists. If the same user name exists and the flag is not set to true, the user is left as is. Otherwise, the user is created or updated as the case dictates.		The <code>users</code> key has a list of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/UserSaveRequest.html UserSaveRequest] objects. These are similar to the standard [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/user/UserCreationRequest.html UserCreationRequest], but they contain an <code>update</code> attribute that is used when the user already exists. If the same user name exists and the flag is not set to true, the user is left as is. Otherwise, the user is created or updated as the case dictates.

	=== Global Parameters ===		=== Global Parameters ===
	The <code>globalParameters</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/GlobalParameter.html GlobalParameter] objects that are to be set into the system. Any current global parameters are either deleted or overridden.		The <code>globalParameters</code> key is a list of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/GlobalParameter.html GlobalParameter] objects that are to be set into the system. Any current global parameters are either deleted or overridden.

	=== Custom Calendars ===		=== Custom Calendars ===
	The <code>customCalendars</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/calendar/CustomCalendarUpdateRequest.html CustomCalendarUpdateRequest] objects. Creates or updates as the case dictates by matching on the name.		The <code>customCalendars</code> key is a list of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/calendar/CustomCalendarUpdateRequest.html CustomCalendarUpdateRequest] objects. Creates or updates as the case dictates by matching on the name.

	=== System Parameters ===		=== System Parameters ===
	The <code>systemParameters</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/SystemParameter.html SystemParameter] objects. Updates all parameters given.		The <code>systemParameters</code> key is a list of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/SystemParameter.html SystemParameter] objects. Updates all parameters given.

	=== Subscribers ===		=== Subscribers ===
	The <code>subscribers</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SubscriberSaveRequest.html SubscriberSaveRequest] objects. Creates or updates as the case dictates by matching on the email address.		The <code>subscribers</code> key is a list of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SubscriberSaveRequest.html SubscriberSaveRequest] objects. Creates or updates as the case dictates by matching on the email address.

	=== Templates ===		=== Templates ===
	The <code>templates</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/TemplateSaveRequest.html TemplateSaveRequest] objects. Creates or updates as the case dictates by matching on the name.		The <code>templates</code> key is a list of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/TemplateSaveRequest.html TemplateSaveRequest] objects. Creates or updates as the case dictates by matching on the name.

	== Sample ==		== Sample ==

Craig at 18:41, 9 June 2023

2023-06-09T18:41:05Z

← Older revision		Revision as of 18:41, 9 June 2023
Line 7:		Line 7:

	=== Backup or Export ===		=== Backup or Export ===
	Use the System Restore [[REST_Endpoints#GET_a_system_restore_configuration\|GET REST endpoint]] or the [[Embedded_API#Get_System_Restore_Configuration\|equivalent Embedded API]] to retrieve a [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration]. Store the JSON representation in your backup media.		Use the System Restore [[REST_Endpoints#GET_a_system_restore_configuration\|GET REST endpoint]] or the [[Embedded_API#Get_System_Restore_Configuration\|equivalent Embedded API]] to retrieve a [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration]. Store the JSON representation in your backup media.

	=== Transfer or Restore a Configuration ===		=== Transfer or Restore a Configuration ===
	Follow the [[#~~Backup_or_export~~\|Backup]] instructions. Then, using the backup JSON, you can either place it on the file-system/classpath as described in [[#Startup_Initialization\|Startup Initialization]], or use it in conjunction with the System Restore [[REST_Endpoints#PUT_a_system_restore_configuration\|PUT REST endpoint]] or [[Embedded_API#Update_System_Restore_Configuration\|equivalent Embedded API]].		Follow the [[Initializing_and_Restoring#Backup_or_Export\|Backup]] instructions. Then, using the backup JSON, you can either place it on the file-system/classpath as described in [[#Startup_Initialization\|Startup Initialization]], or use it in conjunction with the System Restore [[REST_Endpoints#PUT_a_system_restore_configuration\|PUT REST endpoint]] or [[Embedded_API#Update_System_Restore_Configuration\|equivalent Embedded API]].

	You may choose to update parts of the exported configuration depending on your needs, or to set new user passwords.		You may choose to update parts of the exported configuration depending on your needs, or to set new user passwords.
Line 24:		Line 24:

	== JSON Configuration Format ==		== JSON Configuration Format ==
	The file format is a JSON serialized version of the [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration] class. Here we will define each configuration item and any special conditions associated with each one. A sample JSON is [[#Sample\|provided]].		The file format is a JSON serialized version of the [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration] class. Here we will define each configuration item and any special conditions associated with each one. A sample JSON is [[#Sample\|provided]].

	=== Jobs ===		=== Jobs ===
	The <code>jobs</code> key has a list of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/JobSaveRequest.html JobSaveRequest] objects. Each of these represents a configured job in Obsidian. This JobSaveRequest is very much like a [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/JobCreationRequest.html JobCreationRequest] but having two extra attributes to handle the case where a job with the same nickname already exists. The <code>updateAttributes</code> flag is used to determine whether the job attributes (jobClass, recoveryType, pickupBufferMinutes, etc.) will be updated when the job exists. The <code>updateSchedule</code> flag is used to determine whether to apply the current schedule and any additional <code>jobSchedules</code> when the job already exists. If any of the schedules' end dates are in the past, they will be skipped.		The <code>jobs</code> key has a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/JobSaveRequest.html JobSaveRequest] objects. Each of these represents a configured job in Obsidian. This JobSaveRequest is very much like a [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/JobCreationRequest.html JobCreationRequest] but having two extra attributes to handle the case where a job with the same nickname already exists. The <code>updateAttributes</code> flag is used to determine whether the job attributes (jobClass, recoveryType, pickupBufferMinutes, etc.) will be updated when the job exists. The <code>updateSchedule</code> flag is used to determine whether to apply the current schedule and any additional <code>jobSchedules</code> when the job already exists. If any of the schedules' end dates are in the past, they will be skipped.

	=== Job Chains ===		=== Job Chains ===
	The <code>chains</code> key is a [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/ChainsRequest.html ChainsRequest] that houses a collection of chain configurations and a <code>replaceAll</code> attribute. The replaceAll attribute is used when chains already exist in the system. If chains exist and the flag is not set to true, the existing chains are left as is. If set to true, all existing chains are deleted and the new set of chains are created.		The <code>chains</code> key is a [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/ChainsRequest.html ChainsRequest] that houses a collection of chain configurations and a <code>replaceAll</code> attribute. The replaceAll attribute is used when chains already exist in the system. If chains exist and the flag is not set to true, the existing chains are left as is. If set to true, all existing chains are deleted and the new set of chains are created.

	=== Job Conflicts ===		=== Job Conflicts ===
	The <code>conflicts</code> key is similar to the [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/ConflictUpdateRequest.html ConflictUpdateRequest] but it uses job nicknames instead of job IDs. If an empty list is supplied, all chains will be deleted. Note that this is different from a null or missing value.		The <code>conflicts</code> key is similar to the [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/ConflictUpdateRequest.html ConflictUpdateRequest] but it uses job nicknames instead of job IDs. If an empty list is supplied, all chains will be deleted. Note that this is different from a null or missing value.

	=== Users ===		=== Users ===
	The <code>users</code> key has a list of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/UserSaveRequest.html UserSaveRequest] objects. These are similar to the standard [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/user/UserCreationRequest.html UserCreationRequest], but they contain an <code>update</code> attribute that is used when the user already exists. If the same user name exists and the flag is not set to true, the user is left as is. Otherwise, the user is created or updated as the case dictates.		The <code>users</code> key has a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/UserSaveRequest.html UserSaveRequest] objects. These are similar to the standard [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/user/UserCreationRequest.html UserCreationRequest], but they contain an <code>update</code> attribute that is used when the user already exists. If the same user name exists and the flag is not set to true, the user is left as is. Otherwise, the user is created or updated as the case dictates.

	=== Global Parameters ===		=== Global Parameters ===
	The <code>globalParameters</code> key is a list of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/GlobalParameter.html GlobalParameter] objects that are to be set into the system. Any current global parameters are either deleted or overridden.		The <code>globalParameters</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/GlobalParameter.html GlobalParameter] objects that are to be set into the system. Any current global parameters are either deleted or overridden.

	=== Custom Calendars ===		=== Custom Calendars ===
	The <code>customCalendars</code> key is a list of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/calendar/CustomCalendarUpdateRequest.html CustomCalendarUpdateRequest] objects. Creates or updates as the case dictates by matching on the name.		The <code>customCalendars</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/calendar/CustomCalendarUpdateRequest.html CustomCalendarUpdateRequest] objects. Creates or updates as the case dictates by matching on the name.

	=== System Parameters ===		=== System Parameters ===
	The <code>systemParameters</code> key is a list of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/SystemParameter.html SystemParameter] objects. Updates all parameters given.		The <code>systemParameters</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/SystemParameter.html SystemParameter] objects. Updates all parameters given.

	=== Subscribers ===		=== Subscribers ===
	The <code>subscribers</code> key is a list of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SubscriberSaveRequest.html SubscriberSaveRequest] objects. Creates or updates as the case dictates by matching on the email address.		The <code>subscribers</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SubscriberSaveRequest.html SubscriberSaveRequest] objects. Creates or updates as the case dictates by matching on the email address.

	=== Templates ===		=== Templates ===
	The <code>templates</code> key is a list of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/TemplateSaveRequest.html TemplateSaveRequest] objects. Creates or updates as the case dictates by matching on the name.		The <code>templates</code> key is a list of [https://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/TemplateSaveRequest.html TemplateSaveRequest] objects. Creates or updates as the case dictates by matching on the name.

	== Sample ==		== Sample ==

Carfey: /* Sample */

2017-04-11T22:59:22Z

Sample

← Older revision		Revision as of 22:59, 11 April 2017
Line 127:		Line 127:
	"effectiveDate": "2015-01-01T00:00:00-0700"		"effectiveDate": "2015-01-01T00:00:00-0700"
	"endDate": "2999-12-31T23:59:00-0800"		"endDate": "2999-12-31T23:59:00-0800"
			}
			],
			"globalParameters": [
			{
			"name": "dbPassword",
			"type": "STRING",
			"values": ["secret"]
	}		}
	],		],

Carfey at 16:41, 1 July 2016

2016-07-01T16:41:46Z

← Older revision		Revision as of 16:41, 1 July 2016
Line 1:		Line 1:
	~~'''As of Obsidian 3.0.0'''~~

	At times, you may wish to perform initialization, backup or restoration of an Obsidian installation. For example, you may wish to take a known good configuration from a development environment and apply it to a test environment.		At times, you may wish to perform initialization, backup or restoration of an Obsidian installation. For example, you may wish to take a known good configuration from a development environment and apply it to a test environment.

Craig: /* Sample */

2016-06-05T23:47:42Z

Sample

← Older revision		Revision as of 23:47, 5 June 2016
Line 77:		Line 77:
	"recoveryType": "NONE",		"recoveryType": "NONE",
	"hosts": [ "Demo-PC" ],		"hosts": [ "Demo-PC" ],
	"ordinalParameters": [		"ordinalParameters": [ // as of 3.8.0, prior to 3.8.0, this was simply the child element "parameters"
	"ordinal": 0,		"ordinal": 0, // as of 3.8.0
	"parameters": [		"parameters": [
	{		{

Craig: /* Sample */

2016-06-05T23:47:05Z

Sample

← Older revision		Revision as of 23:47, 5 June 2016
Line 77:		Line 77:
	"recoveryType": "NONE",		"recoveryType": "NONE",
	"hosts": [ "Demo-PC" ],		"hosts": [ "Demo-PC" ],
	"parameters": [		"ordinalParameters": [
	{		"ordinal": 0,
	"name": "level",		"parameters": [
	"type": "STRING",		{
	"value": "ALL"		"name": "level",
	},		"type": "STRING",
	{		"value": "ALL"
	"name": "maxAgeDays",		},
	"type": "INTEGER",		{
	"value": "120"		"name": "maxAgeDays",
	}		"type": "INTEGER",
			"value": "120"
			}
			]
	],		],
	"chainAll": false,		"chainAll": false,
Line 108:		Line 111:
	"recoveryType": "NONE",		"recoveryType": "NONE",
	"hosts": [],		"hosts": [],
	"parameters": [		"ordinalParameters": [
	{		"ordinal": 0,
	"name": "script",		"parameters": [
	"type": "STRING",		{
	"value": "sdfds"		"name": "script",
	}		"type": "STRING",
			"value": "sdfds"
			}
			]
	],		],
	"chainAll": false,		"chainAll": false,

Carfey at 18:05, 15 December 2015

2015-12-15T18:05:47Z

← Older revision		Revision as of 18:05, 15 December 2015
Line 1:		Line 1:
	'''As of Obsidian 3.0.0'''		'''As of Obsidian 3.0.0'''

	At times, you may wish to perform initialization, backup or restoration of an Obsidian ~~configuration~~. For example, you may wish to take a known good configuration from a development environment and apply it to a test environment.		At times, you may wish to perform initialization, backup or restoration of an Obsidian installation. For example, you may wish to take a known good configuration from a development environment and apply it to a test environment.

	In Obsidian 3.0.0, we introduce support that leverages the [[Embedded_API#SystemRestoreManager_API\|System Restore]] functionality of our API. Both the [[Embedded_API\|Embedded API]] and [[REST_API\|REST API]] expose ~~individual~~ functions for retrieving and updating the ~~entire breadth of~~ an Obsidian ~~configuration~~. Rather than require you to individually retrieve all the configuration items and then apply them elsewhere, ~~we now introduce~~ a ~~system wide~~ snapshot ~~of an entire Obsidian installation combined with JSON formatted file-based initialization~~ allowing for easy backups and restores.		In Obsidian 3.0.0, we introduce support that leverages the [[Embedded_API#SystemRestoreManager_API\|System Restore]] functionality of our API. Both the [[Embedded_API\|Embedded API]] and [[REST_API\|REST API]] expose functions for retrieving and updating the full configuration for an Obsidian installation. Rather than require you to individually retrieve all the configuration items and then apply them elsewhere, a full JSON snapshot can be generated and imported, allowing for easy backups and restores.


Line 9:		Line 9:

	=== Backup or Export ===		=== Backup or Export ===
	~~Simply use~~ the System Restore [[REST_Endpoints#GET_a_system_restore_configuration\|GET REST endpoint]] or the [[Embedded_API#Get_System_Restore_Configuration\|equivalent Embedded API]] to retrieve a [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration]. Store the JSON representation in your backup media.		Use the System Restore [[REST_Endpoints#GET_a_system_restore_configuration\|GET REST endpoint]] or the [[Embedded_API#Get_System_Restore_Configuration\|equivalent Embedded API]] to retrieve a [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/system/restore/SystemRestoreConfiguration.html SystemRestoreConfiguration]. Store the JSON representation in your backup media.

	=== Transfer or Restore a Configuration ===		=== Transfer or Restore a Configuration ===

Carfey: /* Sample */

2015-01-30T02:23:09Z

Sample

← Older revision		Revision as of 02:23, 30 January 2015
Line 71:		Line 71:
	],		],
	"jobClass": "com.carfey.ops.job.maint.LogCleanupJob",		"jobClass": "com.carfey.ops.job.maint.LogCleanupJob",
			"minExecutionDuration": "2s",
			"maxExecutionDuration": "3s",
	"nickname": "Log Cleanup",		"nickname": "Log Cleanup",
	"pickupBufferMinutes": 2,		"pickupBufferMinutes": 2,

Carfey: /* Job Conflicts */

2015-01-30T02:05:21Z

Job Conflicts

← Older revision		Revision as of 02:05, 30 January 2015
Line 35:		Line 35:

	=== Job Conflicts ===		=== Job Conflicts ===
	The <code>conflicts</code> key is similar to the [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/ConflictUpdateRequest.html ConflictUpdateRequest] but it uses job nicknames instead of job IDs.		The <code>conflicts</code> key is similar to the [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/job/ConflictUpdateRequest.html ConflictUpdateRequest] but it uses job nicknames instead of job IDs. If an empty list is supplied, all chains will be deleted. Note that this is different from a null or missing value.

	=== Users ===		=== Users ===