• Publicity: Public Only All

install-procs.tcl

Procs which may be invoked using similarly named elements in an install.xml file.

Location:
packages/acs-tcl/tcl/install-procs.tcl
Created:
2004-06-16
Author:
Lee Denison <lee@thaum.net>
CVS Identification:
$Id: install-procs.tcl,v 1.39 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

install::xml::action::add-subsite-admin (public)

 install::xml::action::add-subsite-admin node

Add a member to a subsite's admins group.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) group::add_member group::add_member (public) install::xml::object_id::object install::xml::object_id::object (public) install::xml::object_id::package install::xml::object_id::package (public) xml_node_get_children xml_node_get_children (public) install::xml::action::add-subsite-admin install::xml::action::add-subsite-admin install::xml::action::add-subsite-admin->apm_attribute_value install::xml::action::add-subsite-admin->group::add_member install::xml::action::add-subsite-admin->install::xml::object_id::object install::xml::action::add-subsite-admin->install::xml::object_id::package install::xml::action::add-subsite-admin->xml_node_get_children

Testcases:
No testcase defined.

install::xml::action::add-subsite-member (public)

 install::xml::action::add-subsite-member node

Add a member to a subsites application group.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) group::add_member group::add_member (public) install::xml::object_id::application-group install::xml::object_id::application-group (public) install::xml::object_id::object install::xml::object_id::object (public) xml_node_get_children xml_node_get_children (public) install::xml::action::add-subsite-member install::xml::action::add-subsite-member install::xml::action::add-subsite-member->apm_attribute_value install::xml::action::add-subsite-member->group::add_member install::xml::action::add-subsite-member->install::xml::object_id::application-group install::xml::action::add-subsite-member->install::xml::object_id::object install::xml::action::add-subsite-member->xml_node_get_children

Testcases:
No testcase defined.

install::xml::action::ats-page (public)

 install::xml::action::ats-page node

Creates an ATS Page.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) db_string db_string (public) install::xml::util::get_id install::xml::util::get_id (public) install::xml::action::ats-page install::xml::action::ats-page install::xml::action::ats-page->apm_attribute_value install::xml::action::ats-page->db_string install::xml::action::ats-page->install::xml::util::get_id

Testcases:
No testcase defined.

install::xml::action::create-package (public)

 install::xml::action::create-package node

Create a relation type.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_package_instance_new apm_package_instance_new (public) apm_required_attribute_value apm_required_attribute_value (public) install::xml::util::get_id install::xml::util::get_id (public) permission::set_not_inherit permission::set_not_inherit (public) install::xml::action::create-package install::xml::action::create-package install::xml::action::create-package->apm_attribute_value install::xml::action::create-package->apm_package_instance_new install::xml::action::create-package->apm_required_attribute_value install::xml::action::create-package->install::xml::util::get_id install::xml::action::create-package->permission::set_not_inherit

Testcases:
No testcase defined.

install::xml::action::create-user (public)

 install::xml::action::create-user node

Create a new user. local-p should be set to true when this action is used in the bootstrap install.xml - this ensures we call the auth::local api directly while the service contract has not been setup.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 acs_magic_object acs_magic_object (public) acs_sc::invoke acs_sc::invoke (public) apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) auth::authority::local auth::authority::local (public) install::xml::action::create-user install::xml::action::create-user install::xml::action::create-user->acs_magic_object install::xml::action::create-user->acs_sc::invoke install::xml::action::create-user->apm_attribute_value install::xml::action::create-user->apm_required_attribute_value install::xml::action::create-user->auth::authority::local

Testcases:
No testcase defined.

install::xml::action::install (public)

 install::xml::action::install node

Installs a package including dependencies.

<install package="package-key />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_required_attribute_value apm_required_attribute_value (public) apm_simple_package_install apm_simple_package_install (public) install::xml::action::install install::xml::action::install install::xml::action::install->apm_required_attribute_value install::xml::action::install->apm_simple_package_install

Testcases:
No testcase defined.

install::xml::action::location (public)

 install::xml::action::location node

Creates a URL location object.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::action::wizard install::xml::action::wizard (public) install::xml::action::location install::xml::action::location install::xml::action::wizard->install::xml::action::location apm_attribute_value apm_attribute_value (public) install::xml::action::location->apm_attribute_value apm_invoke_install_proc apm_invoke_install_proc (public) install::xml::action::location->apm_invoke_install_proc apm_required_attribute_value apm_required_attribute_value (public) install::xml::action::location->apm_required_attribute_value install::xml::util::get_id install::xml::util::get_id (public) install::xml::action::location->install::xml::util::get_id xml_node_get_children xml_node_get_children (public) install::xml::action::location->xml_node_get_children

Testcases:
No testcase defined.

install::xml::action::mount (public)

 install::xml::action::mount node

Mounts a package on a specified node.

<mount package="package-key instance-name="name" mount-point="url" />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) install::xml::util::get_id install::xml::util::get_id (public) permission::set_not_inherit permission::set_not_inherit (public) site_node::get site_node::get (public) install::xml::action::mount install::xml::action::mount install::xml::action::mount->apm_attribute_value install::xml::action::mount->apm_required_attribute_value install::xml::action::mount->install::xml::util::get_id install::xml::action::mount->permission::set_not_inherit install::xml::action::mount->site_node::get

Testcases:
No testcase defined.

install::xml::action::mount-existing (public)

 install::xml::action::mount-existing node

Mounts an existing package on a specified node.

<mount-existing package-id="package-id mount-point="url" />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_package_id_from_key apm_package_id_from_key (public) install::xml::util::get_id install::xml::util::get_id (public) site_node::get site_node::get (public) site_node::get_from_url site_node::get_from_url (public) install::xml::action::mount-existing install::xml::action::mount-existing install::xml::action::mount-existing->apm_attribute_value install::xml::action::mount-existing->apm_package_id_from_key install::xml::action::mount-existing->install::xml::util::get_id install::xml::action::mount-existing->site_node::get install::xml::action::mount-existing->site_node::get_from_url

Testcases:
No testcase defined.

install::xml::action::register-parameter (public)

 install::xml::action::register-parameter node

Registers a package parameter.

<register-parameter name="parameter" description="description" package-key="package-key" scope="instance or global" default-value="default-value" datatype="datatype" [ [ [ section="section" ] min-n-values="min-n-values" ] max-n-values="max-n-values" ] [ callback="callback" ] [ parameter-id="parameter-id" ]

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) callback callback (public) install::xml::action::register-parameter install::xml::action::register-parameter install::xml::action::register-parameter->apm_attribute_value install::xml::action::register-parameter->apm_required_attribute_value install::xml::action::register-parameter->callback

Testcases:
No testcase defined.

install::xml::action::relation-add (public)

 install::xml::action::relation-add node

Create a relation.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_required_attribute_value apm_required_attribute_value (public) relation_add relation_add (public) install::xml::action::relation-add install::xml::action::relation-add install::xml::action::relation-add->apm_required_attribute_value install::xml::action::relation-add->relation_add

Testcases:
No testcase defined.

install::xml::action::relation-type (public)

 install::xml::action::relation-type node

Create a relation type.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) rel_types::new rel_types::new (public) install::xml::action::relation-type install::xml::action::relation-type install::xml::action::relation-type->apm_attribute_value install::xml::action::relation-type->apm_required_attribute_value install::xml::action::relation-type->rel_types::new

Testcases:
No testcase defined.

install::xml::action::rename-instance (public)

 install::xml::action::rename-instance node

Change the instance name of an existing package (such as the main subsite). Either the url (if it's mounted) or package_id of the package may be given.

<rename-instance package-id="package-id" url="url" instance-name="new instance name" />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_package_rename apm_package_rename (public) apm_required_attribute_value apm_required_attribute_value (public) install::xml::util::get_id install::xml::util::get_id (public) site_node::get_from_url site_node::get_from_url (public) install::xml::action::rename-instance install::xml::action::rename-instance install::xml::action::rename-instance->apm_attribute_value install::xml::action::rename-instance->apm_package_rename install::xml::action::rename-instance->apm_required_attribute_value install::xml::action::rename-instance->install::xml::util::get_id install::xml::action::rename-instance->site_node::get_from_url

Testcases:
No testcase defined.

install::xml::action::set-id (public)

 install::xml::action::set-id node

set a name/id pair for use in other install xml things

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_required_attribute_value apm_required_attribute_value (public) install::xml::action::set-id install::xml::action::set-id install::xml::action::set-id->apm_required_attribute_value

Testcases:
No testcase defined.

install::xml::action::set-join-policy (public)

 install::xml::action::set-join-policy node

Set the join policy of a group.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_invoke_install_proc apm_invoke_install_proc (public) apm_required_attribute_value apm_required_attribute_value (public) group::update group::update (public) xml_node_get_children xml_node_get_children (public) install::xml::action::set-join-policy install::xml::action::set-join-policy install::xml::action::set-join-policy->apm_invoke_install_proc install::xml::action::set-join-policy->apm_required_attribute_value install::xml::action::set-join-policy->group::update install::xml::action::set-join-policy->xml_node_get_children

Testcases:
No testcase defined.

install::xml::action::set-parameter (public)

 install::xml::action::set-parameter node

Sets a package parameter.

<set-parameter name="parameter" [ package="package-key | url="package-url" ] type="[id|literal]" value="value" />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) install::xml::object_id::package install::xml::object_id::package (public) parameter::set_value parameter::set_value (public) install::xml::action::set-parameter install::xml::action::set-parameter install::xml::action::set-parameter->apm_attribute_value install::xml::action::set-parameter->apm_required_attribute_value install::xml::action::set-parameter->install::xml::object_id::package install::xml::action::set-parameter->parameter::set_value

Testcases:
No testcase defined.

install::xml::action::set-parameter-default (public)

 install::xml::action::set-parameter-default node

Sets a package parameter default value <set-parameter-default name="parameter" package-key="package-key" value="val">

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) parameter::set_default parameter::set_default (public) install::xml::action::set-parameter-default install::xml::action::set-parameter-default install::xml::action::set-parameter-default->apm_attribute_value install::xml::action::set-parameter-default->apm_required_attribute_value install::xml::action::set-parameter-default->parameter::set_default

Testcases:
No testcase defined.

install::xml::action::set-permission (public)

 install::xml::action::set-permission node

Sets permissions on an object.

<set-permissions grantee="party" privilege="package-key />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_invoke_install_proc apm_invoke_install_proc (public) apm_required_attribute_value apm_required_attribute_value (public) permission::grant permission::grant (public) xml_node_get_children xml_node_get_children (public) xml_node_get_children_by_name xml_node_get_children_by_name (public) install::xml::action::set-permission install::xml::action::set-permission install::xml::action::set-permission->apm_invoke_install_proc install::xml::action::set-permission->apm_required_attribute_value install::xml::action::set-permission->permission::grant install::xml::action::set-permission->xml_node_get_children install::xml::action::set-permission->xml_node_get_children_by_name

Testcases:
No testcase defined.

install::xml::action::set-theme (public)

 install::xml::action::set-theme node

Sets a theme for a subsite. If no subsite is specified it defaults to the main subsite "/". Valid themes are e.g. "openacs_bootstrap5", "openacs_bootstrap3", "default_plain", or default "tabbed".

<set-theme theme="theme" [ package="subsite ]

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) site_node::get_node_id site_node::get_node_id (public) site_node::get_object_id site_node::get_object_id (public) subsite::set_theme subsite::set_theme (public) install::xml::action::set-theme install::xml::action::set-theme install::xml::action::set-theme->apm_attribute_value install::xml::action::set-theme->apm_required_attribute_value install::xml::action::set-theme->site_node::get_node_id install::xml::action::set-theme->site_node::get_object_id install::xml::action::set-theme->subsite::set_theme

Testcases:
No testcase defined.

install::xml::action::text (public)

 install::xml::action::text node

A documentation element which ignores its contents and does no processing.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

install::xml::action::unset-permission (public)

 install::xml::action::unset-permission node

Revokes a permissions on an object - has no effect if the permission is not granted directly (i.e. does not act as negative permissions).

<unset-permissions grantee="party" privilege="package-key />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_invoke_install_proc apm_invoke_install_proc (public) apm_required_attribute_value apm_required_attribute_value (public) permission::revoke permission::revoke (public) xml_node_get_children xml_node_get_children (public) xml_node_get_children_by_name xml_node_get_children_by_name (public) install::xml::action::unset-permission install::xml::action::unset-permission install::xml::action::unset-permission->apm_invoke_install_proc install::xml::action::unset-permission->apm_required_attribute_value install::xml::action::unset-permission->permission::revoke install::xml::action::unset-permission->xml_node_get_children install::xml::action::unset-permission->xml_node_get_children_by_name

Testcases:
No testcase defined.

install::xml::action::wizard (public)

 install::xml::action::wizard node

Creates a wizard using the subtags for each step.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) install::xml::action::location install::xml::action::location (public) install::xml::util::get_id install::xml::util::get_id (public) xml_node_get_children xml_node_get_children (public) xml_node_get_name xml_node_get_name (public) install::xml::action::wizard install::xml::action::wizard install::xml::action::wizard->apm_attribute_value install::xml::action::wizard->install::xml::action::location install::xml::action::wizard->install::xml::util::get_id install::xml::action::wizard->xml_node_get_children install::xml::action::wizard->xml_node_get_name

Testcases:
No testcase defined.

install::xml::object_id::admin-group (public)

 install::xml::object_id::admin-group node
Parameters:
node (required)
Returns:
an object_id for an admin group of a given package.

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::object_id::package install::xml::object_id::package (public) install::xml::object_id::admin-group install::xml::object_id::admin-group install::xml::object_id::admin-group->install::xml::object_id::package

Testcases:
No testcase defined.

install::xml::object_id::application-group (public)

 install::xml::object_id::application-group node

Returns an object_id for an application group or relational segment of a given package. The node name is ignored so any node which provides the correct attributes may be used.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::action::add-subsite-member install::xml::action::add-subsite-member (public) install::xml::object_id::application-group install::xml::object_id::application-group install::xml::action::add-subsite-member->install::xml::object_id::application-group apm_attribute_value apm_attribute_value (public) install::xml::object_id::application-group->apm_attribute_value application_group::group_id_from_package_id application_group::group_id_from_package_id (public) install::xml::object_id::application-group->application_group::group_id_from_package_id group::get_rel_segment group::get_rel_segment (public) install::xml::object_id::application-group->group::get_rel_segment install::xml::object_id::package install::xml::object_id::package (public) install::xml::object_id::application-group->install::xml::object_id::package

Testcases:
No testcase defined.

install::xml::object_id::group (public)

 install::xml::object_id::group node

Returns an object_id for a group or relational segment. The node name is ignored so any node which provides the correct attributes may be used.

<group id="group_id" [ type="group type" relation="relation-type" ] />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 apm_attribute_value apm_attribute_value (public) apm_required_attribute_value apm_required_attribute_value (public) group::get_rel_segment group::get_rel_segment (public) install::xml::util::get_id install::xml::util::get_id (public) install::xml::object_id::group install::xml::object_id::group install::xml::object_id::group->apm_attribute_value install::xml::object_id::group->apm_required_attribute_value install::xml::object_id::group->group::get_rel_segment install::xml::object_id::group->install::xml::util::get_id

Testcases:
No testcase defined.

install::xml::object_id::member-group (public)

 install::xml::object_id::member-group node
Parameters:
node (required)
Returns:
an object_id for a member group of a given package.

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::object_id::package install::xml::object_id::package (public) install::xml::object_id::member-group install::xml::object_id::member-group install::xml::object_id::member-group->install::xml::object_id::package

Testcases:
No testcase defined.

install::xml::object_id::object (public)

 install::xml::object_id::object node

Returns a literal object_id for an object. use <object id="-100"> to return the literal id -100.

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::action::add-subsite-admin install::xml::action::add-subsite-admin (public) install::xml::object_id::object install::xml::object_id::object install::xml::action::add-subsite-admin->install::xml::object_id::object install::xml::action::add-subsite-member install::xml::action::add-subsite-member (public) install::xml::action::add-subsite-member->install::xml::object_id::object apm_required_attribute_value apm_required_attribute_value (public) install::xml::object_id::object->apm_required_attribute_value install::xml::util::get_id install::xml::util::get_id (public) install::xml::object_id::object->install::xml::util::get_id

Testcases:
No testcase defined.

install::xml::object_id::package (public)

 install::xml::object_id::package node

Returns an object_id for a package specified in node. The node name is ignored so any node which provides the correct attributes may be used.

<package [ id="id" | key="package-key" | url="package-url" ] />

Parameters:
node (required)

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::action::add-subsite-admin install::xml::action::add-subsite-admin (public) install::xml::object_id::package install::xml::object_id::package install::xml::action::add-subsite-admin->install::xml::object_id::package install::xml::action::file-storage-folder install::xml::action::file-storage-folder (private) install::xml::action::file-storage-folder->install::xml::object_id::package install::xml::action::set-parameter install::xml::action::set-parameter (public) install::xml::action::set-parameter->install::xml::object_id::package install::xml::object_id::admin-group install::xml::object_id::admin-group (public) install::xml::object_id::admin-group->install::xml::object_id::package install::xml::object_id::application-group install::xml::object_id::application-group (public) install::xml::object_id::application-group->install::xml::object_id::package apm_attribute_value apm_attribute_value (public) install::xml::object_id::package->apm_attribute_value apm_package_ids_from_key apm_package_ids_from_key (public) install::xml::object_id::package->apm_package_ids_from_key install::xml::util::get_id install::xml::util::get_id (public) install::xml::object_id::package->install::xml::util::get_id site_node::get_node_id site_node::get_node_id (public) install::xml::object_id::package->site_node::get_node_id site_node::get_object_id site_node::get_object_id (public) install::xml::object_id::package->site_node::get_object_id

Testcases:
No testcase defined.

install::xml::util::get_id (public)

 install::xml::util::get_id id

Returns an id from the global ids variable if it exists and attempts to find an acs_magic_object if not.

Parameters:
id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 install::xml::action::application-link install::xml::action::application-link (private) install::xml::util::get_id install::xml::util::get_id install::xml::action::application-link->install::xml::util::get_id install::xml::action::ats-page install::xml::action::ats-page (public) install::xml::action::ats-page->install::xml::util::get_id install::xml::action::call-tcl-proc install::xml::action::call-tcl-proc (private) install::xml::action::call-tcl-proc->install::xml::util::get_id install::xml::action::create-package install::xml::action::create-package (public) install::xml::action::create-package->install::xml::util::get_id install::xml::action::instantiate-object install::xml::action::instantiate-object (private) install::xml::action::instantiate-object->install::xml::util::get_id acs_magic_object acs_magic_object (public) install::xml::util::get_id->acs_magic_object

Testcases:
No testcase defined.
[ show source ]