USP_DATAFORMTEMPLATE_ADD_CORRESPONDENCEPROCESS

The save procedure used by the add dataform template "Correspondence Process Add Form".

Parameters

Parameter Parameter Type Mode Description
@ID uniqueidentifier INOUT The output parameter indicating the ID of the record added.
@CHANGEAGENTID uniqueidentifier IN Input parameter indicating the ID of the change agent invoking the procedure.
@NAME nvarchar(100) IN Name
@DESCRIPTION nvarchar(255) IN Description
@IDSETREGISTERID uniqueidentifier IN Selected constituents
@LETTERFILENAME nvarchar(255) IN Letter template
@LETTERFILE varbinary IN LETTERFILE
@LABELFILENAME nvarchar(255) IN Mailing label template
@LABELFILE varbinary IN LABELFILE
@QUERYVIEWID uniqueidentifier IN Output format
@UPDATECONSTITUENTRECORD bit IN Update constituent record
@CORRESPONDENCECODEID uniqueidentifier IN Correspondence code
@COMMENTS nvarchar(255) IN Comments
@CREATEOUTPUTIDSET bit IN Create selection
@OUTPUTIDSETNAME nvarchar(100) IN Selection name
@OVERWRITEOUTPUTIDSET bit IN Overwrite existing selection
@EXCLUDEMAIL bit IN
@EXCLUDEPHONE bit IN
@EXCLUDEEMAIL bit IN
@HASNAMEFORMATS bit IN
@ADDRESSEEFORMATID uniqueidentifier IN Use this format, if defined:
@ALTADDRESSEEFORMATID uniqueidentifier IN Otherwise, use this format:
@ADDRESSEEFUNCTIONID uniqueidentifier IN Addressee system format:
@SALUTATIONFORMATID uniqueidentifier IN Use this format, if defined:
@ALTSALUTATIONFORMATID uniqueidentifier IN Otherwise, use this format:
@SALUTATIONFUNCTIONID uniqueidentifier IN Salutation system format:
@CONTACTADDRESSEEFORMATID uniqueidentifier IN Use this format, if defined:
@ALTCONTACTADDRESSEEFORMATID uniqueidentifier IN Otherwise, use this format:
@CONTACTADDRESSEEFUNCTIONID uniqueidentifier IN Contact addressee system format:
@ORGSALUTATIONCODE tinyint IN Organization salutation
@CONTACTSALUTATIONFORMATID uniqueidentifier IN Use this format, if defined:
@ALTCONTACTSALUTATIONFORMATID uniqueidentifier IN Otherwise, use this format:
@CONTACTSALUTATIONFUNCTIONID uniqueidentifier IN Contact salutation system format:
@CONTACTSALUTATIONOPTIONCODE tinyint IN If contact is not available, use:
@CUSTOMNAME nvarchar(100) IN Custom name
@USEADDRESSEEFORMAT bit IN Use the pre-defined name formats for addressee
@USESALUTATIONFORMAT bit IN Use the pre-defined name formats for salutation
@USECONTACTADDRESSEEFORMAT bit IN Use the pre-defined name formats for addressee
@USEADDRESSEESYSTEMFUNCTION bit IN Use a system function to build the name formats for addressee
@USESALUTATIONSYSTEMFUNCTION bit IN Use a system function to build the name formats for salutation
@USECONTACTADDRESSEESYSTEMFUNCTION bit IN Use a system function to build the name formats for addressee
@USECONTACTSALUTATIONSYSTEMFUNCTION bit IN Use a system function to build the name formats for salutation
@USECONTACTSALUTATIONFORMAT bit IN Use the pre-defined name formats for salutation

Definition

Copy


                    CREATE procedure dbo.USP_DATAFORMTEMPLATE_ADD_CORRESPONDENCEPROCESS
                        (
                            @ID uniqueidentifier = null output,                        
                            @CHANGEAGENTID uniqueidentifier = null,                        
                            @NAME nvarchar(100)=''
                            @DESCRIPTION nvarchar(255)=''
                            @IDSETREGISTERID uniqueidentifier = null
                            @LETTERFILENAME nvarchar(255) = '',
                            @LETTERFILE varbinary(max) = null,
                            @LABELFILENAME nvarchar(255) = '',
                            @LABELFILE varbinary(max) = null,                            
                            @QUERYVIEWID uniqueidentifier = null,
                            @UPDATECONSTITUENTRECORD bit = 1,
                            @CORRESPONDENCECODEID uniqueidentifier = null,
                            @COMMENTS nvarchar(255) = '',
                            @CREATEOUTPUTIDSET bit = 0,
                            @OUTPUTIDSETNAME nvarchar(100) = ''
                            @OVERWRITEOUTPUTIDSET bit = 0,
                            @EXCLUDEMAIL bit = 0,
                            @EXCLUDEPHONE bit = 0,
                            @EXCLUDEEMAIL bit = 0,
                            @HASNAMEFORMATS bit = 0,
                            @ADDRESSEEFORMATID uniqueidentifier = null,
                            @ALTADDRESSEEFORMATID uniqueidentifier = null,
                            @ADDRESSEEFUNCTIONID uniqueidentifier = null,
                            @SALUTATIONFORMATID uniqueidentifier = null,
                            @ALTSALUTATIONFORMATID uniqueidentifier = null,
                            @SALUTATIONFUNCTIONID uniqueidentifier = null,
                            @CONTACTADDRESSEEFORMATID uniqueidentifier = null,
                            @ALTCONTACTADDRESSEEFORMATID uniqueidentifier = null,
                            @CONTACTADDRESSEEFUNCTIONID uniqueidentifier = null,
                            @ORGSALUTATIONCODE tinyint = 0,
                            @CONTACTSALUTATIONFORMATID uniqueidentifier = null,
                            @ALTCONTACTSALUTATIONFORMATID uniqueidentifier = null,
                            @CONTACTSALUTATIONFUNCTIONID uniqueidentifier = null,
                            @CONTACTSALUTATIONOPTIONCODE tinyint = 0,
                            @CUSTOMNAME nvarchar(100) = '',
                            @USEADDRESSEEFORMAT bit = 0,
                            @USESALUTATIONFORMAT bit = 0,
                            @USECONTACTADDRESSEEFORMAT bit = 0,
                            @USEADDRESSEESYSTEMFUNCTION bit = 0,
                            @USESALUTATIONSYSTEMFUNCTION bit = 0,
                            @USECONTACTADDRESSEESYSTEMFUNCTION bit = 0,
                            @USECONTACTSALUTATIONSYSTEMFUNCTION bit = 0,
                            @USECONTACTSALUTATIONFORMAT bit = 0

                        )
                        as
                            set nocount on;
                            declare @CURRENTDATE datetime;

                            if @ID is null
                                set @ID = newid();

                            if @CHANGEAGENTID is null  
                                exec dbo.USP_CHANGEAGENT_GETORCREATECHANGEAGENT @CHANGEAGENTID output;

                            set @CURRENTDATE = getdate();

                            begin try                        
                                insert into dbo.CORRESPONDENCEPROCESS
                                    (    ID, 
                                        NAME, 
                                        DESCRIPTION, 
                                        IDSETREGISTERID, 
                                        [LETTERFILENAME],
                                        [LETTERFILE],
                                        [LABELFILENAME],
                                        [LABELFILE],                                        
                                        QUERYVIEWID,    
                                        UPDATECONSTITUENTRECORD,
                                        CORRESPONDENCECODEID,                                        
                                        COMMENTS,                                        
                                        CREATEOUTPUTIDSET,
                                        OUTPUTIDSETNAME,
                                        OVERWRITEOUTPUTIDSET,
                                        EXCLUDEMAIL,
                                        EXCLUDEPHONE,
                                        EXCLUDEEMAIL,
                                        ADDEDBYID, 
                                        CHANGEDBYID, 
                                        DATEADDED, 
                                        DATECHANGED)
                                values
                                    (    @ID
                                        @NAME
                                        @DESCRIPTION
                                        @IDSETREGISTERID
                                        @LETTERFILENAME,
                                        @LETTERFILE,
                                        @LABELFILENAME,
                                        @LABELFILE,                                        
                                        @QUERYVIEWID,
                                        @UPDATECONSTITUENTRECORD,
                                        @CORRESPONDENCECODEID,
                                        @COMMENTS,
                                        @CREATEOUTPUTIDSET
                                        @OUTPUTIDSETNAME
                                        @OVERWRITEOUTPUTIDSET,
                                        @EXCLUDEMAIL,
                                        @EXCLUDEPHONE,
                                        @EXCLUDEEMAIL,
                                        @CHANGEAGENTID
                                        @CHANGEAGENTID
                                        @CURRENTDATE
                                        @CURRENTDATE);

                                if @HASNAMEFORMATS = 1
                                    begin
                                    declare @NAMEFORMATID uniqueidentifier;
                                    set @NAMEFORMATID = newid();

                                    insert into dbo.CORRESPONDENCEPROCESSNAMEFORMAT
                                        (    ID, 
                                            CORRESPONDENCEPROCESSID,
                                            ADDRESSEEFORMATID,
                                            ALTADDRESSEEFORMATID,
                                            ADDRESSEEFUNCTIONID,
                                            SALUTATIONFORMATID,
                                            ALTSALUTATIONFORMATID,
                                            SALUTATIONFUNCTIONID,
                                            CONTACTADDRESSEEFORMATID,
                                            ALTCONTACTADDRESSEEFORMATID,
                                            CONTACTADDRESSEEFUNCTIONID,
                                            ORGSALUTATIONCODE,
                                            CONTACTSALUTATIONFORMATID,
                                            ALTCONTACTSALUTATIONFORMATID,
                                            CONTACTSALUTATIONFUNCTIONID,
                                            CONTACTSALUTATIONOPTIONCODE,
                                            CUSTOMNAME,
                                            USEADDRESSEEFORMAT,
                                            USESALUTATIONFORMAT,
                                            USECONTACTADDRESSEEFORMAT,
                                            USECONTACTSALUTATIONFORMAT,
                                            ADDEDBYID, 
                                            CHANGEDBYID, 
                                            DATEADDED, 
                                            DATECHANGED)
                                    values
                                        (    @NAMEFORMATID,
                                            @ID
                                            @ADDRESSEEFORMATID,
                                            @ALTADDRESSEEFORMATID,
                                            @ADDRESSEEFUNCTIONID,
                                            @SALUTATIONFORMATID,
                                            @ALTSALUTATIONFORMATID,
                                            @SALUTATIONFUNCTIONID,
                                            @CONTACTADDRESSEEFORMATID,
                                            @ALTCONTACTADDRESSEEFORMATID,
                                            @CONTACTADDRESSEEFUNCTIONID,
                                            @ORGSALUTATIONCODE,
                                            @CONTACTSALUTATIONFORMATID,
                                            @ALTCONTACTSALUTATIONFORMATID,
                                            @CONTACTSALUTATIONFUNCTIONID,
                                            @CONTACTSALUTATIONOPTIONCODE,
                                            @CUSTOMNAME,
                                            @USEADDRESSEEFORMAT,
                                            @USESALUTATIONFORMAT,
                                            @USECONTACTADDRESSEEFORMAT,
                                            @USECONTACTSALUTATIONFORMAT,
                                            @CHANGEAGENTID
                                            @CHANGEAGENTID
                                            @CURRENTDATE
                                            @CURRENTDATE);
                                    end
                            end try

                            begin catch
                                exec dbo.USP_RAISE_ERROR;
                                return 1;
                            end catch

                            return 0;